Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closes #1839 dummy function created #2538

Closed
wants to merge 16 commits into from
3 changes: 2 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ Authors@R: c(
person("Kangjie", "Zhang", role = "aut"),
person("Zelos", "Zhu", role = "aut"),
person("F. Hoffmann-La Roche AG", role = c("cph", "fnd")),
person("GlaxoSmithKline LLC", role = c("cph", "fnd"))
person("GlaxoSmithKline LLC", role = c("cph", "fnd")),
person("Shunsuke", "Goto", role = "aut")
)
Description: A toolbox for programming Clinical Data Interchange Standards
Consortium (CDISC) compliant Analysis Data Model (ADaM) datasets in R.
Expand Down
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ again. (#2462)

- New `country_code_lookup()` metadata added to decode countries based on [ISO 3166 codes](https://www.iso.org/iso-3166-country-codes.html). (#2388)

- Added function `my_first_fcn()` (#1839).

## Updates of Existing Functions

- `group_var` (optional) parameter is added to `derive_var_trtemfl()` to derive `TRTEMFL` for AE data if the data are collected as one episode of AE with multiple lines. (#2302)
Expand Down
21 changes: 21 additions & 0 deletions R/my_first_fcn.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#' my_first_fcn
#'
#' my first function
#'
#' @details
#' This is a function created as dummy.
#'
#' @keywords other_advanced
#'
#' @family other_advanced
#'
#' @return
#' This function returns the Character "Welcome to the admiral family!".
#'
#' @export
#'
#' @examples
#' my_first_fcn() ## returns "Welcome to the admiral family!"
my_first_fcn <- function() {
"Welcome to the admiral family!"
}
1 change: 1 addition & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,7 @@ eg
egfr
evaluable
exprs
fcn
fil
findable
fmt
Expand Down
1 change: 1 addition & 0 deletions man/admiral-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions man/list_tte_source_objects.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 27 additions & 0 deletions man/my_first_fcn.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/params.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions tests/testthat/test-my_first_fcn.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# my_first_fcn ----
## Test 1: <Explanation of the test> ----
test_that("multiplication works", {
expected_output <- "Welcome to the admiral family!"

actual_output <- my_first_fcn()

expect_equal(expected_output, actual_output)
})
Loading