diff --git a/R/dummy_function.R b/R/dummy_function.R index 98ebbaab4..f35cd22b7 100644 --- a/R/dummy_function.R +++ b/R/dummy_function.R @@ -1,13 +1,13 @@ -#' Generate sample `CDISC` datasets +#' Generate sample CDISC datasets #' -#' Retrieves example `CDISC` datasets for use in examples and testing. +#' Retrieves example CDISC datasets for use in examples and testing. #' #' This function returns a dummy dataset and should only be used within `teal.data`. #' Note that the datasets are not created and maintained in `teal.data`, they are retrieved its dependencies. #' -#' @param dataname (`character(1)`) name of a `CDISC` dataset +#' @param dataname (`character(1)`) name of a CDISC dataset #' -#' @return A `CDISC` dataset as a `data.frame`. +#' @return A CDISC dataset as a `data.frame`. #' #' @export example_cdisc_data <- function(dataname = c("ADSL", "ADAE", "ADLB", "ADCM", "ADEX", "ADRS", "ADTR", "ADTTE", "ADVS")) { diff --git a/R/join_keys.R b/R/join_keys.R index 2c01e6c72..b8e5600c2 100644 --- a/R/join_keys.R +++ b/R/join_keys.R @@ -53,7 +53,7 @@ #' @seealso [join_key()] for creating `join_keys_set`, #' [parents()] for parent operations, #' [teal_data()] for `teal_data` constructor _and_ -#' [default_cdisc_join_keys] for default `CDISC` keys. +#' [default_cdisc_join_keys] for default CDISC keys. #' join_keys <- function(...) { if (missing(...)) { diff --git a/README.md b/README.md index c91d3bbc4..1d5af1b8a 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ This package is used to create the data needed for `teal` applications. This data can be: - Independent data frames -- `CDISC` data (for clinical trial reporting) +- CDISC data (for clinical trial reporting) - Relational data - `MultiAssayExperiment` objects diff --git a/inst/WORDLIST b/inst/WORDLIST index b84a59865..f53064cb2 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -1,3 +1,5 @@ +ADaM +CDISC Forkers Getter Hoffmann diff --git a/man/example_cdisc_data.Rd b/man/example_cdisc_data.Rd index 743f1e4c5..7e268f77b 100644 --- a/man/example_cdisc_data.Rd +++ b/man/example_cdisc_data.Rd @@ -2,20 +2,20 @@ % Please edit documentation in R/dummy_function.R \name{example_cdisc_data} \alias{example_cdisc_data} -\title{Generate sample \code{CDISC} datasets} +\title{Generate sample CDISC datasets} \usage{ example_cdisc_data( dataname = c("ADSL", "ADAE", "ADLB", "ADCM", "ADEX", "ADRS", "ADTR", "ADTTE", "ADVS") ) } \arguments{ -\item{dataname}{(\code{character(1)}) name of a \code{CDISC} dataset} +\item{dataname}{(\code{character(1)}) name of a CDISC dataset} } \value{ -A \code{CDISC} dataset as a \code{data.frame}. +A CDISC dataset as a \code{data.frame}. } \description{ -Retrieves example \code{CDISC} datasets for use in examples and testing. +Retrieves example CDISC datasets for use in examples and testing. } \details{ This function returns a dummy dataset and should only be used within \code{teal.data}. diff --git a/man/join_keys.Rd b/man/join_keys.Rd index 9723218ee..ec2a7f1bb 100644 --- a/man/join_keys.Rd +++ b/man/join_keys.Rd @@ -205,5 +205,5 @@ join_keys(td) \code{\link[=join_key]{join_key()}} for creating \code{join_keys_set}, \code{\link[=parents]{parents()}} for parent operations, \code{\link[=teal_data]{teal_data()}} for \code{teal_data} constructor \emph{and} -\link{default_cdisc_join_keys} for default \code{CDISC} keys. +\link{default_cdisc_join_keys} for default CDISC keys. } diff --git a/vignettes/join-keys.Rmd b/vignettes/join-keys.Rmd index 69a0da48b..a386bc81f 100644 --- a/vignettes/join-keys.Rmd +++ b/vignettes/join-keys.Rmd @@ -20,8 +20,8 @@ Each dataset _joining keys_ can be characterized by: - Foreign/merge keys, analogous to `SQL` foreign keys. Typically, an application developer specifies these keys manually. -However, for datasets following the `ADaM` standard, `teal.data` can automatically assign keys using the `default_cdisc_join_keys` object. -Refer to the section ["Joining Keys with `ADaM` Datasets"](#join-keys-in-adam-datasets) for details on using this object to select specific datasets. +However, for datasets following the ADaM standard, `teal.data` can automatically assign keys using the `default_cdisc_join_keys` object. +Refer to the section ["Joining Keys with ADaM Datasets"](#join-keys-in-adam-datasets) for details on using this object to select specific datasets. ##### Uses of `join_keys` class in _teal_ applications @@ -296,9 +296,9 @@ join_keys(td)["ds2", "ds4"] Note that the definition above contains no `join_key` for `"ds2" <-> "ds4"` -## _Join Keys_ in `ADaM` Datasets +## _Join Keys_ in ADaM Datasets -`teal.data` provides a set of default join keys (primary and foreign) for datasets named according to the `ADaM` standard. They are stored in `default_cdisc_join_keys`. +`teal.data` provides a set of default join keys (primary and foreign) for datasets named according to the ADaM standard. They are stored in `default_cdisc_join_keys`. ```{r} names(default_cdisc_join_keys) |> sort()