Skip to content

monstR is an R package that queries the Office for National Statistics (ONS) API to download data. monstR makes it easy to retrieve publicly available ONS data and meta data.

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
LICENSE.md
Notifications You must be signed in to change notification settings

tomjemmett/monstR

 
 

Repository files navigation

monstR - making ONS tables readable

Project Status: in progress

R-CMD-check

Project Description

This package is a part of our open-source R pipeline to download and clean public data related to health and social care. The aim is to provide analysts, primarily at the Health Foundation, with clean and ready for analysis data.

Overview

monstR - making ONS tables readable is a package that queries the Office for National Statistics (ONS) API to download data. It can be used to retrieve publically available data and meta data from the ONS.

  • ons_available_datasets() returns information about available datasets
  • ons_available_versions() returns information about available dataset versions
  • ons_available_editions() returns information about available dataset editions
  • ons_download() downloads the specified data

Installation

If you have cloned a local copy of the repo, you should be able to load it using devtools

library(devtools)
setwd("{location of monstR repo}")
devtools::load_all()

or to install direct from Github

remotes::install_github("HFAnalyticsLab/monstR", build_vignettes = TRUE )

Design Principles

The monstrR Open Data Pipeline is designed to work well with tidyverse and in particular within pipelines created by the %>% pipe operator. With this in mind, most functions take a data structure in the first argument and return a data structure which has been augmented in some way. Typically this is metadata about the actual data, although once the data has been cleaned it can be accessed using monstr_data(metadata) to get at a tidyverse tibble of the data.

Authors

License

This project is licensed under the MIT License.

About

monstR is an R package that queries the Office for National Statistics (ONS) API to download data. monstR makes it easy to retrieve publicly available ONS data and meta data.

Resources

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
LICENSE.md

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • R 99.3%
  • Emacs Lisp 0.7%