From a8e782ffb52d36a563e5fd90f478a546a420bd39 Mon Sep 17 00:00:00 2001 From: Evan Odell Date: Sun, 17 Jun 2018 22:56:35 +0100 Subject: [PATCH] prep for cran release --- DESCRIPTION | 2 +- NEWS.md | 20 ++++++++++++++------ R/data_download.R | 6 +++++- cran-comments.md | 21 ++++++--------------- man/nomis_get_data.Rd | 6 +++++- 5 files changed, 31 insertions(+), 24 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 1202cfa..8ed1f83 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: nomisr Type: Package Title: Access 'Nomis' UK Labour Market Data -Version: 0.2.0.9000 +Version: 0.3.0 Authors@R: c( person( "Evan", "Odell", email = "evanodell91@gmail.com", role = c("aut", "cre"), diff --git a/NEWS.md b/NEWS.md index e261cd7..cdc9fcf 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,14 +1,22 @@ -# nomisr 0.2.0.9000 +# nomisr 0.3.0 -* Using `rsdmx` to parse metadata, fixing problems with oddly formatted JSON. +## New features and function changes + +* New `nomis_codelist()` function, which returns the internal coding for +different concepts used by the NOMIS API in a \code{tibble}, given a dataset +ID and a concept name. * The `additional_queries` parameter in `nomis_get_data()` and -`nomis_get_metadata()` has been deprecated -and will eventually be removed. Please use the `...` parameter for -queries including concepts not available through the default parameters. +`nomis_get_metadata()` has been deprecated and will eventually be removed. +Please use the `...` parameter for queries including concepts not available +through the default parameters. + +* The `sex` parameter in `nomis_get_data()` will also work with datasets that +use "gender" instead of "sex". -* +## Internal changes and bug fixes +* Uses `rsdmx` to parse metadata, fixing #7. # nomisr 0.2.0 diff --git a/R/data_download.R b/R/data_download.R index 394f502..9c825d7 100644 --- a/R/data_download.R +++ b/R/data_download.R @@ -110,7 +110,11 @@ #' @param ... Use to pass any other parameters to the API. Useful for passing #' concepts that are not available through the default parameters. Only accepts #' concepts identified in \code{\link{nomis_get_metadata}} and concept values -#' identified in \code{\link{nomis_codelist}} +#' identified in \code{\link{nomis_codelist}}. Parameters can be quoted or +#' unquoted, and are not case sensitive. Each parameter should have a name and +#' a value. For example \code{cause_of_death = 10300} and +#' \code{CAUSE_OF_DEATH = 10300} will return the same result when querying +#' dataset "NM_161_1". #' #' @return A tibble containing the selected dataset. #' By default, all tibble columns are parsed as characters. diff --git a/cran-comments.md b/cran-comments.md index b60fff6..467a576 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,24 +1,15 @@ ## Release summary -This is a resubmission of the `nomisr` package, with new version number 0.2.0. -This version removes redundant description text and places 'Nomis' in -single quotes in the DESCRIPTION file, and includes details on external -package reviewers. It also includes a more flexible method for API key -handling. `nomisr` provides functions to download UK census data and other -official statistics from the 'nomis' API. +This is an update of the `nomisr` package, version number 0.3.0. +This version has updated syntax allowing for greater flexibility in +data queries, a new `nomis_codelist()` function and various internal bug fixes. ## Test environments -* local OS X install, R 3.4.4 -* ubuntu 14.04 (on travis-ci), R 3.4.4 +* local OS X install, R 3.5.0 +* ubuntu 14.04 (on travis-ci), (devel and release) * win-builder (devel and release) ## R CMD check results -0 errors | 0 warnings | 2 notes - -* This is a new release. - -* Possibly mis-spelled words in DESCRIPTION: - DWP (9:67) - Nomis (3:15, 8:53, 9:5) +0 errors | 0 warnings | 0 notes diff --git a/man/nomis_get_data.Rd b/man/nomis_get_data.Rd index b81c92c..e468d90 100644 --- a/man/nomis_get_data.Rd +++ b/man/nomis_get_data.Rd @@ -88,7 +88,11 @@ excluding all others. \code{select} is not case sensitive.} \item{...}{Use to pass any other parameters to the API. Useful for passing concepts that are not available through the default parameters. Only accepts concepts identified in \code{\link{nomis_get_metadata}} and concept values -identified in \code{\link{nomis_codelist}}} +identified in \code{\link{nomis_codelist}}. Parameters can be quoted or +unquoted, and are not case sensitive. Each parameter should have a name and +a value. For example \code{cause_of_death = 10300} and +\code{CAUSE_OF_DEATH = 10300} will return the same result when querying +dataset "NM_161_1".} } \value{ A tibble containing the selected dataset.