Closes #1839 dummy function created

NAMESPACE

@@ -138,6 +138,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)

R/.gitignore

@@ -0,0 +1 @@
+my_first_fcn.R

R/my_first_fcn.R

@@ -0,0 +1,25 @@
+#' @name my_first_fcn.R
+#'
+#' @title Hello Admiral Function
+#'
+#' @param hw TRUE or FALSE
+#'
+#' @details First function to generate welcome message
+#'
+#' @return Happy Message
+#'
+#' @family der_adsl
+#'
+#' @keywords der_adsl
+#'
+#' @export
+#'
+#' @examples
+#' hello_admiral(hw = FALSE)
+hello_admiral <- function(hw = TRUE) {
+  if (hw) {
+    message("Welcome to the admiral family!")
+  } else {
+    message("Welcome to the admiral family!")
+  }
+}

inst/WORDLIST

@@ -193,6 +193,7 @@ README
 Rahal
 Ratford
 Romain
+Rothstein
 SCE
 SCN
 SCOPEN
@@ -249,6 +250,7 @@ admiralophtha
 admiralvaccine
 admiralxxx
 adsl
+adxx
 alanine
 aminotransferase
 analyte

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!\\n"
+  )
+})
+
+test_that("hello admiral greets with hw", {
+  expect_message(
+    hello_admiral(hw = TRUE),
+    "^Welcome to the admiral family!\\n"
+  )
+})
+
+test_that("hello admiral greets with hw", {
+  expect_message(
+    hello_admiral(hw = FALSE),
+    "^Welcome to the admiral family!\\n"
+  )
+})