Closes #1839 dummy function created

NAMESPACE

@@ -137,6 +137,7 @@ export(get_not_mapped)
 export(get_one_to_many_dataset)
 export(get_summary_records)
 export(get_vars_query)
+export(hello_admiral)
 export(impute_dtc_dt)
 export(impute_dtc_dtm)
 export(lastalive_censor)

NEWS.md

@@ -2,6 +2,8 @@
 
 ## New Features
 
+- Created function `hello_admiral()` as part of onboarding task. (#1839)
+
 ## Updates of Existing Functions
 
 ## Breaking Changes

R/my_first_fcn.R

@@ -0,0 +1,21 @@
+#' Derive Extension Example
+#'
+#' Says hello admiral
+#'
+#' @param hw TRUE or FALSE
+#'
+#' @author Anders
+#'
+#' @return Happy Message
+#'
+#' @export
+#'
+#' @examples
+#' hello_admiral(hw = FALSE)
+hello_admiral <- function(hw = TRUE) {
+  if (hw) {
+    message("Welcome to the admiral family hw!")
+  } else {
+    message("Welcome to the admiral family!")
+  }
+}

inst/WORDLIST

@@ -36,8 +36,8 @@ Akinyi
 Alanine
 Alkalosis
 Analyte
+Anders
 Ania
-Asha
 Aspartate
 BDS
 BILI
@@ -61,7 +61,6 @@ CTCAEV
 CTCAEv
 CVD
 Carlucci
-Chakma
 Cheatsheet
 Chemistries
 Chol
@@ -96,7 +95,6 @@ Fibrinogen
 Findability
 Framingham
 Franciszek
-Francois
 Fridericia
 Fridericia's
 Fujimoto
@@ -304,6 +302,7 @@ modularized
 msec
 nd
 occds
+onboarding
 onwards
 parttime
 pharmaverse

tests/testthat/test-my_first_fcn.R

@@ -0,0 +1,20 @@
+test_that("hello admiral greets without hw", {
+  expect_message(
+    hello_admiral(),
+    "^Welcome to the admiral family hw!\\n"
+  )
+})
+
+test_that("hello admiral greets with hm", {
+  expect_message(
+    hello_admiral(hw = TRUE),
+    "^Welcome to the admiral family hw!\\n"
+  )
+})
+
+test_that("hello admiral greets with hw", {
+  expect_message(
+    hello_admiral(hw = FALSE),
+    "^Welcome to the admiral family!\\n"
+  )
+})