Summary

  • What does this package do? (explain in 50 words or less):

Downloads UK official statistics from the Nomis API and converts to R objects, primarily tibbles. The API is based around different statistical geographies.

  • Paste the full DESCRIPTION file inside a code block below:
Package: nomisr
Type: Package
Title: Access Nomis UK Labour Market Data with R
Version: 0.0.2
Date: 2018-01-30
Authors@R: person("Evan Odell", email="evanodell91@gmail.com",
  role=c("aut", "cre"),
  comment = c(ORCID='0000-0003-1845-808X'))
Author: Evan Odell [aut, cre]
Maintainer: Evan Odell <evanodell91@gmail.com>
Description: Access UK official statistics from the Nomis database through R. 
    Nomis includes data from the Census, the Labour Force Survey, DWP benefit 
    statistics and other economic and demographic data from the Office for 
    National Statistics, based around statistical geographies. See 
    <https://www.nomisweb.co.uk/api/v01/help> for full API documentation.
URL: https://github.com/EvanOdell/nomisr
BugReports: https://github.com/EvanOdell/nomisr/issues
License: MIT + file LICENSE
Imports: 
  jsonlite,
  tibble,
  readr,
  dplyr,
  curl
RoxygenNote: 6.0.1
Suggests: 
  knitr,
  rmarkdown,
  testthat
VignetteBuilder: knitr
  • URL for the package (the development repository, not a stylized html page):

https://github.com/EvanOdell/nomisr

  • Please indicate which category or categories from our package fit policies this package falls under *and why(? (e.g., data retrieval, reproducibility. If you are unsure, we suggest you make a pre-submission inquiry.):

[e.g., “data extraction, because the package parses a scientific data file format”]

Data retrieval, because the package assists the downloading of a data from an API into R.

  • Who is the target audience and what are scientific applications of this package?

Demographers, economists, geographers, public health researchers, any other social scientists who are interested in geographic factors. The package will aid reproducibility, reduce the need to manually download area profiles, and allow easy linking of different datasets covering the same geographic area.

There are no other R packages specifically for retrieving this data. Some of the data on Nomis is also available through the UK Data Service with the ukds package, but other ONS data, including labour force, benefits, mortality and business statistics are not otherwise available through an R package. The UK Data Service also requires users registration, while Nomis does not, and does not, as far as I can tell, provide the same linking with statistical geographies as Nomis.

  • If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted.

Requirements

Confirm each of the following by checking the box. This package:

  • [x] does not violate the Terms of Service of any service it interacts with.
  • [x] has a CRAN and OSI accepted license.
  • [x] contains a README with instructions for installing the development version.
  • [x] includes documentation with examples for all functions.
  • [x] contains a vignette with examples of its essential functions and uses.
  • [x] has a test suite.
  • [x] has continuous integration, including reporting of test coverage, using services such as Travis CI, Coveralls and/or CodeCov.
  • [x] I agree to abide by ROpenSci’s Code of Conduct during the review process and in maintaining my package should it be accepted.

Publication options

  • [x] Do you intend for this package to go on CRAN?
  • [ ] Do you wish to automatically submit to the Journal of Open Source Software? If so:
    • [ ] The package has an obvious research application according to JOSS’s definition.
    • [ ] The package contains a paper.md matching JOSS’s requirements with a high-level description in the package root or in inst/.
    • [ ] The package is deposited in a long-term repository with the DOI:
    • (Do not submit your package separately to JOSS)
  • [ ] Do you wish to submit an Applications Article about your package to Methods in Ecology and Evolution? If so:
    • [ ] The package is novel and will be of interest to the broad readership of the journal.
    • [ ] The manuscript describing the package is no longer than 3000 words.
    • [ ] You intend to archive the code for the package in a long-term repository which meets the requirements of the journal.
    • (Please do not submit your package separately to Methods in Ecology and Evolution)

Detail

  • [x] Does R CMD check (or devtools::check()) succeed? Paste and describe any errors or warnings:

  • [x] Does the package conform to rOpenSci packaging guidelines? Please describe any exceptions:

  • If this is a resubmission following rejection, please explain the change in circumstances:

  • If possible, please provide recommendations of reviewers - those with experience with similar packages and/or likely users of your package - and their GitHub user names: