Some further edits to documentation

ellessenne · Jan 17, 2022 · 0856b42 · 0856b42
1 parent 5125ed4
commit 0856b42
Show file tree

Hide file tree

Showing 12 changed files with 47 additions and 7 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -52,7 +52,7 @@ Modified the behaviour of the `assign0` argument after further discussion with [
 
 ### BREAKING CHANGES
 
-`comorbidity` now returns two Elixhauser scores, one computed using the algorithm of val Walraven _et al_. (2009) and a second one computed using the AHRQ algorithm (Moore _et al_., 2017). Thanks to Yumiko Abe-Jones for feedback and the discussion regarding weighted Elixhauser scores.
+`comorbidity` now returns two Elixhauser scores, one computed using the algorithm of van Walraven _et al_. (2009) and a second one computed using the AHRQ algorithm (Moore _et al_., 2017). Thanks to Yumiko Abe-Jones for feedback and the discussion regarding weighted Elixhauser scores.
 
 More information can be found on the package vignette: `vignette("comorbidityscores", package = "comorbidity")`.
 

diff --git a/R/score.R b/R/score.R
@@ -8,7 +8,7 @@
 #' * `charlson`, for the original weights by Charlson et al. (1987);
 #' * `quan`, for the revised weights by Quan et al. (2011).
 #' Possible values for the Elixhauser score are:
-#' * `vw`, for the weights by van Walraver et al. (2009);
+#' * `vw`, for the weights by van Walraven et al. (2009);
 #' * `swiss`, for the Swiss Elixhauser weights by Sharma et al. (2021).
 #'
 #' Defaults to `NULL`, in which case an unweighted score will be used.

diff --git a/README.Rmd b/README.Rmd
@@ -144,7 +144,11 @@ Weighted an unweighted comorbidity scores can be obtained using the `score()` fu
 
 ```{r score}
 unw_cci <- score(charlson, weights = NULL, assign0 = FALSE)
+unw_cci
+
 quan_cci <- score(charlson, weights = "quan", assign0 = FALSE)
+quan_cci
+
 all.equal(unw_cci, quan_cci)
 ```
 

diff --git a/README.md b/README.md
@@ -48,6 +48,9 @@ For instance, we could simulate ICD-10 codes:
 ``` r
 # load the comorbidity package
 library(comorbidity)
+## This is {comorbidity} version 1.0.0.
+## A lot has changed since the last release on CRAN, please check-out breaking changes here:
+## -> https://ellessenne.github.io/comorbidity/articles/C-changes.html
 # set a seed for reproducibility
 set.seed(1)
 # simulate 50 ICD-10 codes for 5 individuals
@@ -193,7 +196,19 @@ Weighted an unweighted comorbidity scores can be obtained using the
 
 ``` r
 unw_cci <- score(charlson, weights = NULL, assign0 = FALSE)
+unw_cci
+## [1] 2 1 0
+## attr(,"map")
+## [1] "charlson_icd10_quan"
+
 quan_cci <- score(charlson, weights = "quan", assign0 = FALSE)
+quan_cci
+## [1] 6 2 0
+## attr(,"map")
+## [1] "charlson_icd10_quan"
+## attr(,"weights")
+## [1] "quan"
+
 all.equal(unw_cci, quan_cci)
 ## [1] "Attributes: < Length mismatch: comparison on first 1 components >"
 ## [2] "Mean relative difference: 1.666667"

diff --git a/docs/articles/A-introduction.html b/docs/articles/A-introduction.html
diff --git a/docs/articles/C-changes.html b/docs/articles/C-changes.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -5,7 +5,7 @@ articles:
   A-introduction: A-introduction.html
   B-comorbidity-scores: B-comorbidity-scores.html
   C-changes: C-changes.html
-last_built: 2022-01-17T13:49Z
+last_built: 2022-01-17T14:52Z
 urls:
   reference: https://ellessenne.github.io/comorbidity/reference
   article: https://ellessenne.github.io/comorbidity/articles

diff --git a/docs/reference/score.html b/docs/reference/score.html
diff --git a/docs/search.json b/docs/search.json
diff --git a/man/score.Rd b/man/score.Rd