Skip to content

Commit

Permalink
Merge pull request #57 from nhs-r-community/update-readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@tomjemmett
tomjemmett committed Jul 28, 2023
2 parents 87800e0 + e6c9e26 commit 03f2dde
Show file tree
Hide file tree
Showing 4 changed files with 201 additions and 73 deletions.
139 changes: 120 additions & 19 deletions CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
@@ -1,25 +1,126 @@
# Contributor Code of Conduct
# Contributor Covenant Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.
## Our Pledge

We are committed to making participation in this project a harassment-free experience for
everyone, regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, colour, religion, or sexual
identity and orientation.

Examples of unacceptable behavior by participants include the use of sexual language or
imagery, derogatory comments or personal attacks, trolling, public or private harassment,
insults, or other unprofessional conduct.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

Project maintainers have the right and responsibility to remove, edit, or reject comments,
commits, code, wiki edits, issues, and other contributions that are not aligned to this
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
from the project team.
## Our Standards

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
opening an issue or contacting one or more of the project maintainers.
Examples of behaviour that contributes to a positive environment for our
community include:

This Code of Conduct is adapted from the Contributor Covenant
(https://www.contributor-covenant.org), version 1.0.0, available at
https://contributor-covenant.org/version/1/0/0/.
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at nhs.rcommunity@nhs.net.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion].

For answers to common questions about this code of conduct, see the FAQ at
<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

[homepage]: https://www.contributor-covenant.org
46 changes: 26 additions & 20 deletions README.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,41 +24,47 @@ knitr::opts_chunk$set(

<br><br>

Please visit: [nhsrcommunity.com](https://nhsrcommunity.com/)
## Data sources for reuse

## Datasources 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.

This package has been created to help NHS, Public Health and related analysts/data scientists learn to use `R`. It contains several free datasets (just one at the moment), help files explaining their structure, and `vignette` examples of their use. We encourage contributions to the package, both to expand the set of training material, but also as development for newer `R`/github users as a first contribution. Please add relevant free, open source data sets that you think may benefit the NHS-R Community.
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

This packages is available on CRAN or the development version can be installed from source, via this Github repository. You will need [`Rtools`](https://cran.r-project.org/bin/windows/Rtools/) installed to build the package, and the `remotes` package.
You can install the package from [CRAN](https://CRAN.R-project.org) with:

```{r install, eval=FALSE}
remotes::install_github("https://github.com/nhs-r-community/NHSRdatasets")
``` r
install.packages("NHSRdatasets")
```

## Contribution
To install the development version from [GitHub](https://github.com/) with:

Please contribute to this repository, and please cite it when you use it in training or publications.
```{r install, eval=FALSE}
# install.packages("remotes")
remotes::install_github("nhs-r-community/NHSRdatasets")
```

__To contribute, please:__
## Contributing

* Fork the repository.
* Add your dataset in the `data` folder, in `.rda` format. The best way to do this is with the `usethis` package with "gzip" compression: `usethis::use_data(data, compress="gzip")`
* Please add a minimal `R` function to act as a help file. You can use the `LOS_model` as a guide.
* Please add a `vignette` demonstrating how the data has been/can be used.
* Create a pull request, detailing your additions, and we will review it before merging.
Please see our [guidance on how to contribute](https://tools.nhsrcommunity.com/contribution.html).

<br>
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 data.
* Where based on patient data, the contributor takes full responsibility for sharing the data and certifies that. it is has been processed, anonymised, aggregated or otherwise protected in accordance with all legal requirements under General Data Protection Regulation (GDPR), or other relevant legislation.
* 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

Please note that the 'NHSRdatasets' project is released with a
[Contributor Code of Conduct](https://github.com/nhs-r-community/NHSRdatasets/blob/master/CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.
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 - Source: Office for National Statistics licensed under the Open Government Licence.
83 changes: 49 additions & 34 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,18 @@ version](https://www.r-pkg.org/badges/version/NHSRdatasets)](https://cran.r-proj

<br><br>

Please visit: [nhsrcommunity.com](https://nhsrcommunity.com/)
## Data sources for reuse

## Datasources 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 `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.

This package has been created to help NHS, Public Health and related
analysts/data scientists learn to use `R`. It contains several free
Expand All @@ -26,49 +35,55 @@ structure, and `vignette` examples of their use. We encourage
contributions to the package, both to expand the set of training
material, but also as development for newer `R`/github users as a first
contribution. Please add relevant free, open source data sets that you
think may benefit the NHS-R Community.
think may benefit the NHS-R Community. \>\>\>\>\>\>\>
87800e0b30f9343e0d00493ca9daf6040c72790e

## Installation instructions

This packages is available on CRAN or the development version can be
installed from source, via this Github repository. You will need
[`Rtools`](https://cran.r-project.org/bin/windows/Rtools/) installed to
build the package, and the `remotes` package.
You can install the [CRAN](https://CRAN.R-project.org) with:

``` r
remotes::install_github("https://github.com/nhs-r-community/NHSRdatasets")
install.packages("NHSRdatasets")
```

## Contribution
To install the development version from [GitHub](https://github.com/)
use:

``` r
# install.packages("remotes")
remotes::install_github("nhs-r-community/NHSRdatasets")
```

Please contribute to this repository, and please cite it when you use it
in training or publications.
## Contributing

**To contribute, please:**
Please see our [guidance on how to
contribute](https://tools.nhsrcommunity.com/contribution.html).

- Fork the repository.
- Add your dataset in the `data` folder, in `.rda` format. The best way
to do this is with the `usethis` package with “gzip” compression:
`usethis::use_data(data, compress="gzip")`
- Please add a minimal `R` function to act as a help file. You can use
the `LOS_model` as a guide.
- Please add a `vignette` demonstrating how the data has been/can be
used.
- Create a pull request, detailing your additions, and we will review it
before merging.
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.

<br> ***When contributing a dataset, the contributor certifies that:***
***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 data.
- Where based on patient data, the contributor takes full responsibility
for sharing the data and certifies that. it is has been processed,
anonymised, aggregated or otherwise protected in accordance with all
legal requirements under General Data Protection Regulation (GDPR), or
other relevant legislation.

Please note that the ‘NHSRdatasets’ project is released with a
[Contributor Code of
Conduct](https://github.com/nhs-r-community/NHSRdatasets/blob/master/CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.
- 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

Please cite the use of {NHSRdatasets} and promote the work of the NHS-R
Community!

## 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 - Source: Office for National Statistics licensed
under the Open Government Licence.
6 changes: 6 additions & 0 deletions vignettes/ons_mortality.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -522,3 +522,9 @@ ons_mortality %>%
```{r removefiles}
unlink("working_files", recursive = TRUE)
```


# Citations

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 - Source: Office for National Statistics licensed under the Open Government Licence.

0 comments on commit 03f2dde

Please sign in to comment.