Closes #1839 dummy function created

DESCRIPTION

@@ -72,4 +72,4 @@ Encoding: UTF-8
 Language: en-US
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2

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)

NEWS.md

@@ -2,8 +2,7 @@
 
 ## New Features
 
-- New function `derive_vars_crit_flag()` for deriving criterion flag variables
-(`CRITy`, `CRITyFL`, `CRITyFLN`). (#2468)
+- New function 'my_first_fcn()' as dummy practice (#1839)
 
 ## Updates of Existing Functions
 

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_adxx
+#'
+#' @keywords der_adxx
+#'
+#' @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

@@ -14,6 +14,7 @@ ADVS
 ADaM
 ADaMIG
 ADaMs
+adxx
 AE
 AEDECOD
 AELLTCD
@@ -89,6 +90,7 @@ EPI
 Ehmann
 FACM
 FCVD
+fcn
 Fibrinogen
 Findability
 Framingham

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"
+  )
+})