README.md

demographr

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

Overview

demographr is an R package for distributing UK demographic data:

Installation

You can install the development version from GitHub with:

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

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 devtools::check() to check for errors/warnings/notes.
  6. 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

Developed by Mike Page, Matt Thomas and Aileen McDonald at the British Red Cross.

See LICESNE



humaniverse/demographr documentation built on June 10, 2025, 5:39 p.m.