Updated README with vignette links

nhs-r-community · Jan 25, 2024 · d0bb0df · d0bb0df
1 parent e188cb9
commit d0bb0df
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -31,6 +31,8 @@ You can install the current version of `NHSRpopulation` from [GitHub](https://gi
 remotes::install_github("nhs-r-community/NHSRpopulation")
 ```
 
+To find out more about the functions there is a vignette for [Getting Started](https://nhs-r-community.github.io/NHSRpopulation/articles/get-started.html) and for information on how to recalculate the IMD deciles for local areas only and not with England see this [vignette](https://nhs-r-community.github.io/NHSRpopulation/articles/calc-imd-ranks-within-la.html).
+
 ## Sources of Data
 
 The original source of the data provided in this R package is available [here](https://www.ons.gov.uk/peoplepopulationandcommunity/populationandmigration/populationestimates/datasets/lowersuperoutputareamidyearpopulationestimates) and licenced under the [Open Government Licence v3.0](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).

diff --git a/README.md b/README.md
@@ -29,6 +29,12 @@ You can install the current version of `NHSRpopulation` from
 remotes::install_github("nhs-r-community/NHSRpopulation")
 ```
 
+To find out more about the functions there is a vignette for [Getting
+Started](https://nhs-r-community.github.io/NHSRpopulation/articles/get-started.html)
+and for information on how to recalculate the IMD deciles for local
+areas only and not with England see this
+[vignette](https://nhs-r-community.github.io/NHSRpopulation/articles/calc-imd-ranks-within-la.html).
+
 ## Sources of Data
 
 The original source of the data provided in this R package is available