Skip to content

Commit

Permalink
Added conversion factors in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yurovska committed Oct 30, 2024
1 parent d745aca commit 888d2fa
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 8 deletions.
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Imports:
lifecycle (>= 0.1.0),
lubridate (>= 1.7.4),
magrittr (>= 1.5),
purrr (>= 0.3.3),
rlang (>= 0.4.4),
tidyselect (>= 1.0.0)
Suggests:
Expand Down
2 changes: 2 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ importFrom(lubridate,years)
importFrom(lubridate,ymd)
importFrom(lubridate,ymd_hms)
importFrom(magrittr,"%>%")
importFrom(purrr,discard_at)
importFrom(rlang,"%||%")
importFrom(rlang,":=")
importFrom(rlang,.data)
Expand Down Expand Up @@ -125,6 +126,7 @@ importFrom(stringr,str_c)
importFrom(stringr,str_detect)
importFrom(stringr,str_extract)
importFrom(stringr,str_glue)
importFrom(stringr,str_glue_data)
importFrom(stringr,str_remove)
importFrom(stringr,str_remove_all)
importFrom(stringr,str_replace)
Expand Down
3 changes: 2 additions & 1 deletion R/admiralmetabolic-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
#' starts_with transmute ungroup vars n_distinct union distinct
#' summarise_at summarise coalesce bind_cols na_if tibble tribble
#' @importFrom magrittr %>%
#' @importFrom purrr discard_at
#' @importFrom rlang := %||% abort arg_match as_function as_string call2 caller_env
#' call_name current_env .data enexpr enexprs enquo eval_bare eval_tidy expr
#' exprs expr_interp expr_label f_lhs f_rhs inform
Expand All @@ -21,7 +22,7 @@
#' set_names sym syms type_of warn quo_set_env quo_get_env
#' @importFrom utils capture.output str
#' @importFrom stringr str_c str_detect str_extract str_remove str_remove_all
#' str_replace str_trim str_to_lower str_to_title str_to_upper str_glue
#' str_replace str_trim str_to_lower str_to_title str_to_upper str_glue str_glue_data
#' @importFrom lubridate as_datetime ceiling_date date days duration floor_date is.Date is.instant
#' time_length %--% ymd ymd_hms weeks years hours minutes
#' @importFrom tidyselect all_of contains vars_select
Expand Down
9 changes: 7 additions & 2 deletions R/derive_advs_params.R
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,12 @@ derive_param_waisthgt <- function(dataset,
#' convertible (e.g., centimeters for one parameter and inches for another), an automatic
#' conversion will be performed in order to uniform the values before calculating the ratio.
#'
#' **Note:** Conversion factors come from unit definitions as per the NCI Thesaurus.
#' **Note:** Conversion factors come from unit definitions as per CDISC standards.
#' ```{r, echo = FALSE, comment = "", results = "asis"}
#' get_conv_factors_all()[["length"]] %>%
#' discard_at("cm") %>%
#' str_glue_data("<br/>*{names(.)}* is defined as {.} cm")
#' ```
#'
#' *Permitted Values:* A variable of the input dataset or a function call
#'
Expand Down Expand Up @@ -609,7 +614,7 @@ get_conv_factor <- function(from_unit, to_unit) {

#' @description `get_conv_factors_all()` returns all conversion factors supported.
#'
#' **Note:** Conversion factors come from unit definitions as per the NCI Thesaurus.
#' **Note:** Conversion factors come from unit definitions as per CDISC standards.
#'
#' @rdname unit-conversion
#' @keywords internal
Expand Down
1 change: 0 additions & 1 deletion inst/WORDLIST
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,5 @@ roxygen
advs
PARAMCD
prm
NCI
admiraldev
github
6 changes: 5 additions & 1 deletion man/derive_param_ratio.Rd

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

6 changes: 5 additions & 1 deletion man/derive_param_waisthgt.Rd

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

6 changes: 5 additions & 1 deletion man/derive_param_waisthip.Rd

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

2 changes: 1 addition & 1 deletion man/unit-conversion.Rd

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

0 comments on commit 888d2fa

Please sign in to comment.