Merge pull request #115 from OxfordIHTM/dev

standardise cause-of-death spelling: fix #114

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.

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

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.

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.

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

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.

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:
 #'

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()