Skip to content

humaniverse/healthyr

Repository files navigation

healthyr

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.

Overview

healthyr is an R package for distributing UK health data:

Installation

You can install the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("humaniverse/healthyr")

Development

To add data sets to the package:

  1. Update data-raw/query-urls.R. Keep to alphabetical ordering. Make sure to build and export the tibble.
  2. Add a file to data-raw/. See other files for template.
  3. Document the data set in R/data.R. Keep to alphabetical ordering.
  4. Run devtools::document() to export documentation.
  5. Run broadcast::broadcast() to export the file to .broadcast as a .csv.
  6. Run devtools::check() to check for errors/warnings/notes.
  7. Update LICENSE by adding the license of the new data set if not already covered.

Contributing

To contribute to this project, please follow GitHub Flow when submitting changes.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Credits

See LICENSE

Releases

No releases published

Packages

No packages published

Languages