From 8204b25d949238eebd914d717ddfb80004c5b022 Mon Sep 17 00:00:00 2001
From: Ernest Guevarra <ernest@guevarra.io>
Date: Thu, 4 Jul 2024 11:19:33 +0100
Subject: [PATCH] standardise cause-of-death spelling: fix #114

---
 R/cod_check_age.R             |  2 +-
 R/cod_check_code.R            |  6 +++---
 R/cod_check_dod.R             |  2 +-
 R/cod_check_sex.R             |  2 +-
 R/cod_recode_age_type.R       |  2 +-
 R/cod_recode_sex.R            |  2 +-
 R/data.R                      | 12 ++++++------
 R/utils.R                     |  2 +-
 man/cod_check_age.Rd          |  4 ++--
 man/cod_check_code.Rd         |  8 ++++----
 man/cod_check_dod.Rd          |  4 ++--
 man/cod_check_sex.Rd          |  4 ++--
 man/cod_data_raw_example.Rd   |  6 +++---
 man/cod_recode_age_type.Rd    |  4 ++--
 man/cod_recode_sex.Rd         |  4 ++--
 man/icd10_cod_child.Rd        |  4 ++--
 man/icd10_cod_neonate.Rd      |  4 ++--
 man/icd11_cod_child.Rd        |  4 ++--
 man/icd11_cod_neonate.Rd      |  4 ++--
 man/list_ill_defined_icd11.Rd |  2 +-
 20 files changed, 41 insertions(+), 41 deletions(-)

diff --git a/R/cod_check_age.R b/R/cod_check_age.R
index 64f91bb..61a9033 100644
--- a/R/cod_check_age.R
+++ b/R/cod_check_age.R
@@ -1,5 +1,5 @@
 #'
-#' Check age values in cause of death data based on CoDEdit rules
+#' Check age values in cause-of-death data based on CoDEdit rules
 #'
 #' @param age_value An integer value or vector of values for age based on the
 #'   CoDEdit rules.
diff --git a/R/cod_check_code.R b/R/cod_check_code.R
index acc2839..46fbcea 100644
--- a/R/cod_check_code.R
+++ b/R/cod_check_code.R
@@ -1,7 +1,7 @@
 #'
-#' Check cause of death code for code entry mistakes and/or code completeness
+#' Check cause-of-death code for code entry mistakes and/or code completeness
 #'
-#' @param cod A character value or vector of values for cause of death code/s.
+#' @param cod A character value or vector of values for cause-of-death code/s.
 #' @param version A character value for ICD version used. This should be either
 #'   *"icd10"* or *"icd11"*. Default is *"icd10"*.
 #' @param sex A character value or vector of values for sex of individual
@@ -10,7 +10,7 @@
 #'   individual.
 #'
 #' @returns A tibble with 2 columns/fields. First is an integer value indicating
-#'   whether there is an issue with the cause of death code provided in relation
+#'   whether there is an issue with the cause-of-death code provided in relation
 #'   to a potential code entry mistake and/or and issue of code completeness.
 #'
 #' @examples
diff --git a/R/cod_check_dod.R b/R/cod_check_dod.R
index 81c66a1..3c2fa7e 100644
--- a/R/cod_check_dod.R
+++ b/R/cod_check_dod.R
@@ -1,5 +1,5 @@
 #'
-#' Check date of death value in cause of death data based on CoDEdit rules
+#' Check date of death value in cause-of-death data based on CoDEdit rules
 #'
 #' @param dod Date of death value expressed in terms of the year death
 #'   occurred.
diff --git a/R/cod_check_sex.R b/R/cod_check_sex.R
index 65ad9f1..d11a1f8 100644
--- a/R/cod_check_sex.R
+++ b/R/cod_check_sex.R
@@ -1,5 +1,5 @@
 #'
-#' Check sex values in cause of death data based on CoDEdit rules
+#' Check sex values in cause-of-death data based on CoDEdit rules
 #'
 #' @param sex_value An integer value or vector of values for age based on the
 #'   CoDEdit rules.
diff --git a/R/cod_recode_age_type.R b/R/cod_recode_age_type.R
index f2c1965..f977b87 100644
--- a/R/cod_recode_age_type.R
+++ b/R/cod_recode_age_type.R
@@ -1,5 +1,5 @@
 #'
-#' Recode age type of cause of death data based on CoDEdit rules
+#' Recode age type of cause-of-death data based on CoDEdit rules
 #'
 #' @param age_type A vector of values for age type based on the CoDEdit rules.
 #'   This should either be "D" for age in days, "M" for age
diff --git a/R/cod_recode_sex.R b/R/cod_recode_sex.R
index ee99517..f711db7 100644
--- a/R/cod_recode_sex.R
+++ b/R/cod_recode_sex.R
@@ -1,5 +1,5 @@
 #'
-#' Recode sex value of cause of death data based on CoDEdit rules
+#' Recode sex value of cause-of-death data based on CoDEdit rules
 #'
 #' @param sex_value A character or integer value or vector of values signifying
 #'   the sex.
diff --git a/R/data.R b/R/data.R
index ecb8f67..a053a47 100644
--- a/R/data.R
+++ b/R/data.R
@@ -121,7 +121,7 @@
 
 
 #'
-#' Example raw cause of death dataset
+#' Example raw cause-of-death dataset
 #'
 #' @format A data frame with 6 columns and 20 rows:
 #'
@@ -130,7 +130,7 @@
 #' | *id* | Unique identifier |
 #' | *sex* | Sex of deceased |
 #' | *age* | Age of diseased in years |
-#' | *code* | ICD 11 cause of death code |
+#' | *code* | ICD 11 cause-of-death code |
 #' | *dod* | Date of death |
 #' | *dob* | Date of birth |
 #'
@@ -141,7 +141,7 @@
 
 
 #'
-#' Neonate-specific cause of death for ICD 10
+#' Neonate-specific cause-of-death for ICD 10
 #'
 #' @format A data frame with 2 columns and 42 rows:
 #'
@@ -160,7 +160,7 @@
 
 
 #'
-#' Neonate-specific cause of death for ICD 11
+#' Neonate-specific cause-of-death for ICD 11
 #'
 #' @format A data frame with 2 columns and 50 rows:
 #'
@@ -178,7 +178,7 @@
 
 
 #'
-#' Child-specific cause of death for ICD 10
+#' Child-specific cause-of-death for ICD 10
 #'
 #' @format A data frame with 2 columns and 122 rows:
 #'
@@ -197,7 +197,7 @@
 
 
 #'
-#' Child-specific cause of death for ICD 11
+#' Child-specific cause-of-death for ICD 11
 #'
 #' @format A data frame with 2 columns and 149 rows:
 #'
diff --git a/R/utils.R b/R/utils.R
index adb11e6..cc155cc 100644
--- a/R/utils.R
+++ b/R/utils.R
@@ -102,7 +102,7 @@ get_score_combo <- function(scores, labels) {
 #' List ill-defined ICD 11 codes
 #'
 #' @returns An character vector of ICD 11 codes classified as ill-defined for
-#'   cause of death
+#'   cause-of-death
 #'
 #' @examples
 #' list_ill_defined_icd11()
diff --git a/man/cod_check_age.Rd b/man/cod_check_age.Rd
index db1d908..237ab1c 100644
--- a/man/cod_check_age.Rd
+++ b/man/cod_check_age.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/cod_check_age.R
 \name{cod_check_age}
 \alias{cod_check_age}
-\title{Check age values in cause of death data based on CoDEdit rules}
+\title{Check age values in cause-of-death data based on CoDEdit rules}
 \usage{
 cod_check_age(age_value, age_type, age_type_code = c("D", "M", "Y"))
 }
@@ -26,7 +26,7 @@ A tibble with number of rows equal to length of \code{age_value} and
 two columns for age_check and age_check_note.
 }
 \description{
-Check age values in cause of death data based on CoDEdit rules
+Check age values in cause-of-death data based on CoDEdit rules
 }
 \examples{
 cod_check_age(120, "Y")
diff --git a/man/cod_check_code.Rd b/man/cod_check_code.Rd
index d1c225a..3048c75 100644
--- a/man/cod_check_code.Rd
+++ b/man/cod_check_code.Rd
@@ -16,7 +16,7 @@
 \alias{cod_check_code_age_icd10}
 \alias{cod_check_code_age_icd11_}
 \alias{cod_check_code_age_icd11}
-\title{Check cause of death code for code entry mistakes and/or code completeness}
+\title{Check cause-of-death code for code entry mistakes and/or code completeness}
 \usage{
 cod_check_code(cod, version = c("icd10", "icd11"), sex, age)
 
@@ -49,7 +49,7 @@ cod_check_code_age_icd11_(cod, age)
 cod_check_code_age_icd11(cod, age)
 }
 \arguments{
-\item{cod}{A character value or vector of values for cause of death code/s.}
+\item{cod}{A character value or vector of values for cause-of-death code/s.}
 
 \item{version}{A character value for ICD version used. This should be either
 \emph{"icd10"} or \emph{"icd11"}. Default is \emph{"icd10"}.}
@@ -62,11 +62,11 @@ individual.}
 }
 \value{
 A tibble with 2 columns/fields. First is an integer value indicating
-whether there is an issue with the cause of death code provided in relation
+whether there is an issue with the cause-of-death code provided in relation
 to a potential code entry mistake and/or and issue of code completeness.
 }
 \description{
-Check cause of death code for code entry mistakes and/or code completeness
+Check cause-of-death code for code entry mistakes and/or code completeness
 }
 \examples{
 cod_check_code("U100", sex = 1, age = 10)
diff --git a/man/cod_check_dod.Rd b/man/cod_check_dod.Rd
index cd90cc2..8e3b435 100644
--- a/man/cod_check_dod.Rd
+++ b/man/cod_check_dod.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/cod_check_dod.R
 \name{cod_check_dod}
 \alias{cod_check_dod}
-\title{Check date of death value in cause of death data based on CoDEdit rules}
+\title{Check date of death value in cause-of-death data based on CoDEdit rules}
 \usage{
 cod_check_dod(dod)
 }
@@ -15,7 +15,7 @@ A tibble with number of rows equal to length of \code{dod} and
 two columns for dod_check and dod_check_note.
 }
 \description{
-Check date of death value in cause of death data based on CoDEdit rules
+Check date of death value in cause-of-death data based on CoDEdit rules
 }
 \examples{
 cod_check_dod("2024")
diff --git a/man/cod_check_sex.Rd b/man/cod_check_sex.Rd
index ff3c82b..05a08ea 100644
--- a/man/cod_check_sex.Rd
+++ b/man/cod_check_sex.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/cod_check_sex.R
 \name{cod_check_sex}
 \alias{cod_check_sex}
-\title{Check sex values in cause of death data based on CoDEdit rules}
+\title{Check sex values in cause-of-death data based on CoDEdit rules}
 \usage{
 cod_check_sex(sex_value, sex_code = c(1, 2))
 }
@@ -20,7 +20,7 @@ A tibble with number of rows equal to length of \code{sex_value} and
 two columns for sex_check and sex_check_note.
 }
 \description{
-Check sex values in cause of death data based on CoDEdit rules
+Check sex values in cause-of-death data based on CoDEdit rules
 }
 \examples{
 cod_check_sex("m", c("m", "f"))
diff --git a/man/cod_data_raw_example.Rd b/man/cod_data_raw_example.Rd
index b8a8867..5379ad3 100644
--- a/man/cod_data_raw_example.Rd
+++ b/man/cod_data_raw_example.Rd
@@ -3,14 +3,14 @@
 \docType{data}
 \name{cod_data_raw_example}
 \alias{cod_data_raw_example}
-\title{Example raw cause of death dataset}
+\title{Example raw cause-of-death dataset}
 \format{
 A data frame with 6 columns and 20 rows:\tabular{ll}{
    \strong{Variable} \tab \strong{Description} \cr
    \emph{id} \tab Unique identifier \cr
    \emph{sex} \tab Sex of deceased \cr
    \emph{age} \tab Age of diseased in years \cr
-   \emph{code} \tab ICD 11 cause of death code \cr
+   \emph{code} \tab ICD 11 cause-of-death code \cr
    \emph{dod} \tab Date of death \cr
    \emph{dob} \tab Date of birth \cr
 }
@@ -19,7 +19,7 @@ A data frame with 6 columns and 20 rows:\tabular{ll}{
 cod_data_raw_example
 }
 \description{
-Example raw cause of death dataset
+Example raw cause-of-death dataset
 }
 \examples{
 cod_data_raw_example
diff --git a/man/cod_recode_age_type.Rd b/man/cod_recode_age_type.Rd
index 58388c9..dcd2493 100644
--- a/man/cod_recode_age_type.Rd
+++ b/man/cod_recode_age_type.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/cod_recode_age_type.R
 \name{cod_recode_age_type}
 \alias{cod_recode_age_type}
-\title{Recode age type of cause of death data based on CoDEdit rules}
+\title{Recode age type of cause-of-death data based on CoDEdit rules}
 \usage{
 cod_recode_age_type(age_type, age_type_code = c("D", "M", "Y"))
 }
@@ -23,7 +23,7 @@ A character value or vector of values containing either "D", "M",
 or "Y" for \emph{days}, \emph{months}, or \emph{years} respectively.
 }
 \description{
-Recode age type of cause of death data based on CoDEdit rules
+Recode age type of cause-of-death data based on CoDEdit rules
 }
 \examples{
 cod_recode_age_type(
diff --git a/man/cod_recode_sex.Rd b/man/cod_recode_sex.Rd
index 426e8f9..33403d2 100644
--- a/man/cod_recode_sex.Rd
+++ b/man/cod_recode_sex.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/cod_recode_sex.R
 \name{cod_recode_sex}
 \alias{cod_recode_sex}
-\title{Recode sex value of cause of death data based on CoDEdit rules}
+\title{Recode sex value of cause-of-death data based on CoDEdit rules}
 \usage{
 cod_recode_sex(sex_value, sex_code = c(1L, 2L), codedit = TRUE)
 }
@@ -23,7 +23,7 @@ or 2 for females. If \code{codedit = TRUE}, values not equal to the \code{sex_co
 values are coded as 9 (integer). Otherwise, it is coded as NA_integer_.
 }
 \description{
-Recode sex value of cause of death data based on CoDEdit rules
+Recode sex value of cause-of-death data based on CoDEdit rules
 }
 \examples{
 cod_recode_sex(
diff --git a/man/icd10_cod_child.Rd b/man/icd10_cod_child.Rd
index 3a5ae2e..3a5a4ff 100644
--- a/man/icd10_cod_child.Rd
+++ b/man/icd10_cod_child.Rd
@@ -3,7 +3,7 @@
 \docType{data}
 \name{icd10_cod_child}
 \alias{icd10_cod_child}
-\title{Child-specific cause of death for ICD 10}
+\title{Child-specific cause-of-death for ICD 10}
 \format{
 A data frame with 2 columns and 122 rows:\tabular{ll}{
    \strong{Variable} \tab \strong{Description} \cr
@@ -18,7 +18,7 @@ https://www.icd10data.com/ICD10CM/Codes/Rules/Pediatric_Codes
 icd10_cod_child
 }
 \description{
-Child-specific cause of death for ICD 10
+Child-specific cause-of-death for ICD 10
 }
 \examples{
 icd10_cod_child
diff --git a/man/icd10_cod_neonate.Rd b/man/icd10_cod_neonate.Rd
index d3ddd1f..c82f7d8 100644
--- a/man/icd10_cod_neonate.Rd
+++ b/man/icd10_cod_neonate.Rd
@@ -3,7 +3,7 @@
 \docType{data}
 \name{icd10_cod_neonate}
 \alias{icd10_cod_neonate}
-\title{Neonate-specific cause of death for ICD 10}
+\title{Neonate-specific cause-of-death for ICD 10}
 \format{
 A data frame with 2 columns and 42 rows:\tabular{ll}{
    \strong{Variable} \tab \strong{Description} \cr
@@ -18,7 +18,7 @@ https://www.icd10data.com/ICD10CM/Codes/Rules/Newborn_Codes
 icd10_cod_neonate
 }
 \description{
-Neonate-specific cause of death for ICD 10
+Neonate-specific cause-of-death for ICD 10
 }
 \examples{
 icd10_cod_neonate
diff --git a/man/icd11_cod_child.Rd b/man/icd11_cod_child.Rd
index 71255f5..98a61fc 100644
--- a/man/icd11_cod_child.Rd
+++ b/man/icd11_cod_child.Rd
@@ -3,7 +3,7 @@
 \docType{data}
 \name{icd11_cod_child}
 \alias{icd11_cod_child}
-\title{Child-specific cause of death for ICD 11}
+\title{Child-specific cause-of-death for ICD 11}
 \format{
 A data frame with 2 columns and 149 rows:\tabular{ll}{
    \strong{Variable} \tab \strong{Description} \cr
@@ -15,7 +15,7 @@ A data frame with 2 columns and 149 rows:\tabular{ll}{
 icd11_cod_child
 }
 \description{
-Child-specific cause of death for ICD 11
+Child-specific cause-of-death for ICD 11
 }
 \examples{
 icd11_cod_child
diff --git a/man/icd11_cod_neonate.Rd b/man/icd11_cod_neonate.Rd
index a354c3a..fb1d0b9 100644
--- a/man/icd11_cod_neonate.Rd
+++ b/man/icd11_cod_neonate.Rd
@@ -3,7 +3,7 @@
 \docType{data}
 \name{icd11_cod_neonate}
 \alias{icd11_cod_neonate}
-\title{Neonate-specific cause of death for ICD 11}
+\title{Neonate-specific cause-of-death for ICD 11}
 \format{
 A data frame with 2 columns and 50 rows:\tabular{ll}{
    \strong{Variable} \tab \strong{Description} \cr
@@ -15,7 +15,7 @@ A data frame with 2 columns and 50 rows:\tabular{ll}{
 icd11_cod_neonate
 }
 \description{
-Neonate-specific cause of death for ICD 11
+Neonate-specific cause-of-death for ICD 11
 }
 \examples{
 icd11_cod_neonate
diff --git a/man/list_ill_defined_icd11.Rd b/man/list_ill_defined_icd11.Rd
index 8604e27..d660ca7 100644
--- a/man/list_ill_defined_icd11.Rd
+++ b/man/list_ill_defined_icd11.Rd
@@ -8,7 +8,7 @@ list_ill_defined_icd11()
 }
 \value{
 An character vector of ICD 11 codes classified as ill-defined for
-cause of death
+cause-of-death
 }
 \description{
 List ill-defined ICD 11 codes