remove backticks around CDISC and ADaM (#257)

in response to @lcd2yyz comments insightsengineering/coredev-tasks#492 (comment) --------- Co-authored-by: m7pr <[email protected]> Co-authored-by: Dony Unardi <[email protected]> Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
insightsengineering · Feb 5, 2024 · 09bb886 · 09bb886
1 parent 602da85
commit 09bb886
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 15 deletions.
diff --git 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
@@ -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
@@ -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
@@ -1,3 +1,5 @@
+ADaM
+CDISC
 Forkers
 Getter
 Hoffmann

diff --git a/man/example_cdisc_data.Rd b/man/example_cdisc_data.Rd
diff --git a/man/join_keys.Rd b/man/join_keys.Rd
diff --git 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()
-Original file line number
+Diff line change
@@ -1,3 +1,5 @@
+    ADaM
+    CDISC
     Forkers
     Getter
     Hoffmann
@@ Expand Down @@