feat: Add my_first_fcn to welcome new users

- Create new function my_first_fcn() - Add corresponding test - Resolves #1839
pharmaverse · Dec 4, 2024 · 7c2ddc8 · 7c2ddc8
1 parent 6b77c1a
commit 7c2ddc8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/R/my_first_fcn.R b/R/my_first_fcn.R
@@ -0,0 +1,11 @@
+#' My First Function
+#'
+#' This function outputs a welcome message for onboarding purposes.
+#'
+#' @return A string with a welcome message.
+#' @export
+#'
+my_first_fcn <- function() {
+  "Welcome to the admiral family!"
+}
+
diff --git a/tests/testthat/test-my_first_fcn.R b/tests/testthat/test-my_first_fcn.R
@@ -0,0 +1,5 @@
+test_that("my_first_fcn works correctly", {
+  result <- my_first_fcn()
+  expect_type(result, "character")  # Test that the output is a string
+  expect_equal(result, "Welcome to the admiral family!")  # Test the exact content
+})