/
README.Rmd
76 lines (51 loc) · 3.86 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# NHS-R Community Datasets <a href='https://nhsrcommunity.com/'><img src='https://nhs-r-community.github.io/assets/logo/nhsr-logo.png' align="right" height="80" /></a>
<!-- badges: start -->
[](https://github.com/nhs-r-community/NHSRdatasets/actions)
[](https://www.repostatus.org/#active)
[](https://cran.r-project.org/package=NHSRdatasets)
[](https://cran.r-project.org/package=NHSRdatasets)
[](https://github.com/nhs-r-community/NHSRdatasets/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
<br><br>
## Data sources for reuse
This package has been created to help NHS, Public Health and related analysts/data scientists learn to use `R`.
It contains several free datasets, with help files, explaining their structure, and includes `vignette` examples of their use.
We encourage contributions to the package, both to expand the set of training material, and also as development for newer `R`/github users as a first or early contribution.
Please add relevant free, open source data sets that you think may benefit the NHS-R Community.
## Installation instructions
You can install the package from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("NHSRdatasets")
```
To install the development version from [GitHub](https://github.com/) with:
```{r install, eval=FALSE}
# install.packages("remotes")
remotes::install_github("nhs-r-community/NHSRdatasets")
```
## Datasets available
Note that the versions can be different between CRAN and currently version 0.3.0 on CRAN doesn't include the Covid-19 data but version 0.3.1 from GitHub does.
Further information on the data can be found through the page https://nhs-r-community.github.io/NHSRdatasets/ which can also be located at the top left of the GitHub repository.
## Contributing
Please see our [guidance on how to contribute](https://tools.nhsrcommunity.com/contribution.html).
This project is released with a Contributor [Code of Conduct](./CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.
___When contributing a dataset, the contributor certifies that:___
* They are the data owner, or are authorised to republish the dataset in question.
* The dataset does not contain real patient-level or any other sensitive data.
* Where it is based on sensitive or patient data, the contributor takes full responsibility for sharing the data and certifies that it has been processed, anonymised, aggregated or otherwise protected in accordance with all legal requirements under General Data Protection Regulation (GDPR), or other relevant legislation.
# Citation
It's great to see the {NHSRdatasets} package and data used as it promotes the work of the NHS-R Community so, where it's relevant and makes sense, please give us a mention!
## Users of the mortality dataset:
The data used to build the mortality dataset in this package is released under © Crown copyright and is free to use under the terms of the Open Government Licence.
Any subsequent use should include a source accreditation to ONS to help people find the original releases and any statistical corrections that may have occurred since this was included in this pacakge - Source: Office for National Statistics licensed under the Open Government Licence.