diff --git a/R/data.R b/R/data.R index d18679a327..6a167f70b4 100644 --- a/R/data.R +++ b/R/data.R @@ -88,7 +88,7 @@ #' Note: Variables `SOC`, `TERM`, `Grade 1`, `Grade 2`,`Grade 3`,`Grade 4`,`Grade 5`, `Definition` #' are from the source document on NCI-CTC website defining the grading criteria. #' [**Common Terminology Criteria for Adverse Events (CTCAE)v4.0**](https://ctep.cancer.gov/protocoldevelopment/electronic_applications/ctc.htm#ctc_40) -#' From these variables only 'TERM' is used in the {admiral} code, the rest are for information and +#' From these variables only 'TERM' is used in the `{admiral}` code, the rest are for information and #' traceability only. #' #' @@ -124,7 +124,7 @@ #' Note: Variables `SOC`, `TERM`, `Grade 1`, `Grade 2`,`Grade 3`,`Grade 4`,`Grade 5`, `Definition` #' are from the source document on NCI-CTC website defining the grading criteria. #' [**Common Terminology Criteria for Adverse Events (CTCAE)v5.0**](https://ctep.cancer.gov/protocoldevelopment/electronic_applications/ctc.htm#ctc_50) -#' From these variables only 'TERM' is used in the {admiral} code, the rest are for information and +#' From these variables only 'TERM' is used in the `{admiral}` code, the rest are for information and #' traceability only. #' #' @@ -162,7 +162,7 @@ #' Note: Variables `SOC`, `TERM`, `SUBGROUP`, `Grade 1`, `Grade 2`,`Grade 3`,`Grade 4`,`Grade 5`, `Definition` #' are from the source document on DAIDS website defining the grading criteria. #' [Division of AIDS (DAIDS) Table for Grading the Severity of Adult and Pediatric Adverse Events -#' From these variables only 'TERM' is used in the {admiral} code, the rest are for information and +#' From these variables only 'TERM' is used in the `{admiral}` code, the rest are for information and #' traceability only. #' #' diff --git a/R/derive_date_vars.R b/R/derive_date_vars.R index fd59df5145..3bafc333cb 100644 --- a/R/derive_date_vars.R +++ b/R/derive_date_vars.R @@ -1248,7 +1248,7 @@ compute_tmf <- function(dtc, #' The date can be imputed (see `date_imputation` argument) #' and the date imputation flag ('`--DTF'`) can be added. #' -#' In {admiral} we don't allow users to pick any single part of the date/time to +#' In `{admiral}` we don't allow users to pick any single part of the date/time to #' impute, we only enable to impute up to a highest level, i.e. you couldn't #' choose to say impute months, but not days. #' @@ -1457,7 +1457,7 @@ derive_vars_dt <- function(dataset, # nolint: cyclocomp_linter #' The date and time can be imputed (see `date_imputation`/`time_imputation` arguments) #' and the date/time imputation flag (`'--DTF'`, `'--TMF'`) can be added. #' -#' In {admiral} we don't allow users to pick any single part of the date/time to +#' In `{admiral}` we don't allow users to pick any single part of the date/time to #' impute, we only enable to impute up to a highest level, i.e. you couldn't #' choose to say impute months, but not days. #' diff --git a/R/derive_vars_dtm_to_tm.R b/R/derive_vars_dtm_to_tm.R index 5a094b2fd1..9eddb33043 100644 --- a/R/derive_vars_dtm_to_tm.R +++ b/R/derive_vars_dtm_to_tm.R @@ -11,7 +11,7 @@ #' @details #' The names of the newly added variables are automatically set by replacing the #' `--DTM` suffix of the `source_vars` with `--TM`. The `--TM` variables are created -#' using the {hms} package. +#' using the `{hms}` package. #' #' @return #' A data frame containing the input dataset with the corresponding time diff --git a/R/duplicates.R b/R/duplicates.R index 43a48e9feb..b7acb7381e 100644 --- a/R/duplicates.R +++ b/R/duplicates.R @@ -4,7 +4,7 @@ #' #' #' @details -#' Many {admiral} function check that the input dataset contains only one record +#' Many `{admiral}` function check that the input dataset contains only one record #' per `by_vars` group and throw an error otherwise. The `get_duplicates_dataset()` #' function allows one to retrieve the duplicate records that lead to an error. #' diff --git a/man/atoxgr_criteria_ctcv4.Rd b/man/atoxgr_criteria_ctcv4.Rd index 00e0a8ee32..c5bd444b31 100644 --- a/man/atoxgr_criteria_ctcv4.Rd +++ b/man/atoxgr_criteria_ctcv4.Rd @@ -41,7 +41,7 @@ value. 'L' is for LOW values, 'H' is for HIGH values. Note: the variable is case Note: Variables \code{SOC}, \code{TERM}, \verb{Grade 1}, \verb{Grade 2},\verb{Grade 3},\verb{Grade 4},\verb{Grade 5}, \code{Definition} are from the source document on NCI-CTC website defining the grading criteria. \href{https://ctep.cancer.gov/protocoldevelopment/electronic_applications/ctc.htm#ctc_40}{\strong{Common Terminology Criteria for Adverse Events (CTCAE)v4.0}} -From these variables only 'TERM' is used in the {admiral} code, the rest are for information and +From these variables only 'TERM' is used in the \code{{admiral}} code, the rest are for information and traceability only. } \seealso{ diff --git a/man/atoxgr_criteria_ctcv5.Rd b/man/atoxgr_criteria_ctcv5.Rd index 70a3ef5aaa..31d09fa7ea 100644 --- a/man/atoxgr_criteria_ctcv5.Rd +++ b/man/atoxgr_criteria_ctcv5.Rd @@ -41,7 +41,7 @@ value. 'L' is for LOW values, 'H' is for HIGH values. Note: the variable is case Note: Variables \code{SOC}, \code{TERM}, \verb{Grade 1}, \verb{Grade 2},\verb{Grade 3},\verb{Grade 4},\verb{Grade 5}, \code{Definition} are from the source document on NCI-CTC website defining the grading criteria. \href{https://ctep.cancer.gov/protocoldevelopment/electronic_applications/ctc.htm#ctc_50}{\strong{Common Terminology Criteria for Adverse Events (CTCAE)v5.0}} -From these variables only 'TERM' is used in the {admiral} code, the rest are for information and +From these variables only 'TERM' is used in the \code{{admiral}} code, the rest are for information and traceability only. } \seealso{ diff --git a/man/atoxgr_criteria_daids.Rd b/man/atoxgr_criteria_daids.Rd index c17e78adae..38bf96c953 100644 --- a/man/atoxgr_criteria_daids.Rd +++ b/man/atoxgr_criteria_daids.Rd @@ -43,7 +43,7 @@ value. 'L' is for LOW values, 'H' is for HIGH values. Note: the variable is case Note: Variables \code{SOC}, \code{TERM}, \code{SUBGROUP}, \verb{Grade 1}, \verb{Grade 2},\verb{Grade 3},\verb{Grade 4},\verb{Grade 5}, \code{Definition} are from the source document on DAIDS website defining the grading criteria. [Division of AIDS (DAIDS) Table for Grading the Severity of Adult and Pediatric Adverse Events -From these variables only 'TERM' is used in the {admiral} code, the rest are for information and +From these variables only 'TERM' is used in the \code{{admiral}} code, the rest are for information and traceability only. } \seealso{ diff --git a/man/derive_vars_dt.Rd b/man/derive_vars_dt.Rd index 176dc48bef..31f545813d 100644 --- a/man/derive_vars_dt.Rd +++ b/man/derive_vars_dt.Rd @@ -132,7 +132,7 @@ The date can be imputed (see \code{date_imputation} argument) and the date imputation flag ('\verb{--DTF'}) can be added. } \details{ -In {admiral} we don't allow users to pick any single part of the date/time to +In \code{{admiral}} we don't allow users to pick any single part of the date/time to impute, we only enable to impute up to a highest level, i.e. you couldn't choose to say impute months, but not days. diff --git a/man/derive_vars_dtm.Rd b/man/derive_vars_dtm.Rd index 32ca6c207e..7aed399ccd 100644 --- a/man/derive_vars_dtm.Rd +++ b/man/derive_vars_dtm.Rd @@ -168,7 +168,7 @@ The date and time can be imputed (see \code{date_imputation}/\code{time_imputati and the date/time imputation flag (\code{'--DTF'}, \code{'--TMF'}) can be added. } \details{ -In {admiral} we don't allow users to pick any single part of the date/time to +In \code{{admiral}} we don't allow users to pick any single part of the date/time to impute, we only enable to impute up to a highest level, i.e. you couldn't choose to say impute months, but not days. diff --git a/man/derive_vars_dtm_to_tm.Rd b/man/derive_vars_dtm_to_tm.Rd index 1f3c7be482..2348105f90 100644 --- a/man/derive_vars_dtm_to_tm.Rd +++ b/man/derive_vars_dtm_to_tm.Rd @@ -23,7 +23,7 @@ This function creates time variable(s) as output from datetime variable(s) \details{ The names of the newly added variables are automatically set by replacing the \code{--DTM} suffix of the \code{source_vars} with \code{--TM}. The \code{--TM} variables are created -using the {hms} package. +using the \code{{hms}} package. } \examples{ library(tibble) diff --git a/man/get_duplicates_dataset.Rd b/man/get_duplicates_dataset.Rd index 59efe4fdcd..06ddf8112f 100644 --- a/man/get_duplicates_dataset.Rd +++ b/man/get_duplicates_dataset.Rd @@ -13,7 +13,7 @@ A \code{data.frame} or \code{NULL} Get Duplicate Records that Led to a Prior Error } \details{ -Many {admiral} function check that the input dataset contains only one record +Many \code{{admiral}} function check that the input dataset contains only one record per \code{by_vars} group and throw an error otherwise. The \code{get_duplicates_dataset()} function allows one to retrieve the duplicate records that lead to an error.