feat: #1839 create my_first_fcn

pharmaverse · Oct 19, 2024 · 8d0fbf7 · 8d0fbf7
1 parent bf9ffdd
commit 8d0fbf7
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 1 deletion.
diff --git a/NAMESPACE b/NAMESPACE
@@ -146,6 +146,7 @@ export(list_all_templates)
 export(list_tte_source_objects)
 export(max_cond)
 export(min_cond)
+export(my_first_fcn)
 export(negate_vars)
 export(params)
 export(print_named_list)

diff --git a/NEWS.md b/NEWS.md
@@ -6,6 +6,7 @@
 `AVALCATx` & `AVALCAxN`. (#2480)
 - New function `derive_vars_crit_flag()` for deriving criterion flag variables
 (`CRITy`, `CRITyFL`, `CRITyFLN`). (#2468)
+- New function `my_first_fcn()` as dummy practice. (#1839)
 
 - Replace use of `data("sdtm")` with `sdtm <- pharmaverse::sdtm` in templates and vignettes. (#2498)
 

diff --git a/R/my_first_fcn.R b/R/my_first_fcn.R
@@ -0,0 +1,16 @@
+#' Print a Greeting Message
+#'
+#' Prints a fixed greeting `message`.
+#'
+#' @return No return value (`NULL`).
+#'
+#' @keywords other_advanced
+#' @family other_advanced
+#'
+#' @export
+#'
+#' @examples
+#' my_first_fcn()
+my_first_fcn <- function() {
+  message("Welcome to the admiral family!")
+}
diff --git a/man/list_tte_source_objects.Rd b/man/list_tte_source_objects.Rd
diff --git a/man/my_first_fcn.Rd b/man/my_first_fcn.Rd
diff --git a/man/params.Rd b/man/params.Rd
diff --git a/tests/testthat/test-my_first_fcn.R b/tests/testthat/test-my_first_fcn.R
@@ -0,0 +1,10 @@
+# my_first_fcn ----
+## Test 1: returns NULL ----
+test_that("my_first_fcn Test 1: returns NULL", {
+  expect_null(my_first_fcn())
+})
+
+## Test 2: produces a message ----
+test_that("my_first_fcn Test 2: produces a message", {
+  expect_message(my_first_fcn(), "^Welcome to the admiral family!\\n$")
+})