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

remove backticks around CDISC and ADaM #257

Merged
merged 12 commits into from
Feb 5, 2024
Merged
8 changes: 4 additions & 4 deletions R/dummy_function.R
Original file line number Diff line number Diff line change
@@ -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")) {
Expand Down
2 changes: 1 addition & 1 deletion R/join_keys.R
Original file line number Diff line number Diff line change
Expand Up @@ -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(...)) {
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
ADaM
CDISC
Forkers
Getter
Hoffmann
Expand Down
8 changes: 4 additions & 4 deletions man/example_cdisc_data.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/join_keys.Rd

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

8 changes: 4 additions & 4 deletions vignettes/join-keys.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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()
Expand Down
Loading