added new tests, expanded nomis_get_data functionality

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: nomisr
 Type: Package
 Title: Access nomis UK labour market data on with R
-Version: 0.0.0.9001
-Date: 2018-01-21
+Version: 0.0.1
+Date: 2018-01-23
 Authors@R: person("Evan Odell", email="evanodell91@gmail.com",
   role=c("aut", "cre"),
   comment = c(ORCID='0000-0003-1845-808X'))
@@ -14,9 +14,8 @@ License: MIT + file LICENSE
 Imports: 
   jsonlite,
   tibble,
-  rjstat,
-  dplyr,
-  curl
+  readr,
+  dplyr
 RoxygenNote: 6.0.1
 Suggests: 
   knitr,

NAMESPACE

@@ -5,5 +5,5 @@ export(nomis_get_data)
 export(nomis_search)
 import(dplyr)
 import(jsonlite)
-import(rjstat)
+import(readr)
 import(tibble)

NEWS.md

@@ -1,6 +1,6 @@
 
 # nomisr 0.0.1
 
-1st release of project. Rudimentary functions for retrieving information on 
-available datasets and downloading complete datasets from nomis.
+1st release. Rudimentary functions for retrieving information on available 
+datasets and downloading datasets from nomis, with some limited parameters.
 

R/data_download.R

@@ -1,22 +1,43 @@
 
 
 #' Retrieve nomis datasets
+#' 
+#' Retrieves specific datasets from nomis, based on their ID. To find dataset 
+#' IDs, use \code{\link{nomis_data_info}}. Datasets are retrived in csv format
+#'  and parsed with the \code{read_csv} function from the \code{readr} package.
 #'
 #' @param id The ID of the dataset to retrieve.
+#' @param time Parameter for selecting common dates. Accepts one of 
+#' \code{NULL} (returns all data),  \code{"latest"} (returns the latest 
+#' available data), \code{"previous"} ( the date prior to "latest"), 
+#' \code{"prevyear"} (the date one year prior to "latest") or \code{"first"} 
+#' (the oldest available data for this dataset).
+#' @param exclude_missing If \code{TRUE}, excludes all missing values. 
+#' Defaults to \code{FALSE}.
 #'
-#' @return A data frame
+#' @return A tibble containing the selected dataset.
 #' @export
 #'
 #' @examples \dontrun{
 #' 
-#' x <- nomis_get_data()
+#' x <- nomis_get_data(id="NM_1_1")
+#' 
+#' y <- nomis_get_data(id="NM_1_1", time="latest")
 #' 
 #' }
-nomis_get_data <- function(id){
+nomis_get_data <- function(id, time=NULL, exclude_missing=FALSE){
 
   if(missing(id)) stop("Dataset ID must be specified")
-
-  query <- paste0("/",id,".jsonstat.json?")
+
+  time_query <- dplyr::if_else(is.null(time)==TRUE,
+                               "",
+                               paste0("&time=", tolower(time)))
+
+  exclude_query <- dplyr::if_else(exclude_missing==TRUE,
+                                  "ExcludeMissingValues=true",
+                                  "")
+
+  query <- paste0("/",id,".data.csv?", time_query, exclude_query)
 
   df <- nomis_collect_util(query)
 

R/data_sets.R

@@ -4,14 +4,18 @@
 #' Retrieve all available data sets or the information available in a specific 
 #' dataset based on its ID.
 #'
-#' @param id Dataset ID. If empty, returns data on all available datasets.
+#' @param id Dataset ID. If empty, returns data on all available datasets. 
+#' If the ID of a dataset, returns metadata for that particular dataset.
 #'
-#' @return A tibble
+#' @return A tibble with all available datasets and their metadata.
 #' @export
 #'
 #' @examples \dontrun{
+#' 
 #' x <- nomis_data_info()
+#' 
 #' }
+
 nomis_data_info <- function(id){
 
   if(missing(id)){

R/nomisr-package.R

@@ -5,15 +5,12 @@
 #' Full API documentation available at 
 #' \url{https://www.nomisweb.co.uk/api/v01/help}
 #' 
-#' The \code{nomisr} package uses the \code{rjstat} package to convert API responses to 
-#' data frames. As a consequence, some metadata is not included. To access
-#' metadata, use the \code{nomis_data_info()} function.
 #' 
 #' @docType package
 #' @name nmisr
 #' @import jsonlite
 #' @import tibble
-#' @import rjstat
+#' @import readr
 #' @import dplyr
 # @useDynLib nomisr
 NULL

R/search.R

@@ -7,15 +7,17 @@
 #'
 #' @param search A string to search for in the name and description of 
 #' datasets.
-#' @param keywords If \code{TRUE}, searches in dataset keywords. Defaults to 
-#' \code{FALSE}. 
+#' @param keywords If \code{TRUE}, searches in dataset keywords instead of 
+#' names and descriptions. Defaults to \code{FALSE}. 
 #'
-#' @return A tibble with the search results.
+#' @return A tibble with details on all datasets matching the search query.
 #' @export
 #'
 #' @examples \dontrun{
 #' 
-#' x <- nomis_search("")
+#' x <- nomis_search("seekers")
+#' 
+#' y <- nomis_search("Claimants", keywords=TRUE)
 #' 
 #' }
 

R/utils-collect.R

@@ -1,15 +1,11 @@
 
 
-## utility function to download data - may need to expand as time goes on
-
-# the basic url for all data downloads
+## utility function to download data
 
 
 nomis_collect_util <- function(query){
 
-  #q <- jsonlite::fromJSON(paste0(collect_root, query), flatten = TRUE)
-
-  df <- tibble::as_tibble(rjstat::fromJSONstat(paste0("https://www.nomisweb.co.uk/api/v01/dataset", query), use_factors = T))
+  df <- readr::read_csv(paste0("https://www.nomisweb.co.uk/api/v01/dataset", query))
 
   df
 

R/utils-query.R

@@ -1,7 +1,5 @@
 
-## utility function to query - may need to expand as time goes on
-
-# the basic url for all data queries
+## utility function for queries on available data
 
 
 nomis_query_util <- function(query){

tests/testthat/test_data_collect.R

@@ -0,0 +1,13 @@
+library(nomisr)
+context("nomis_get_data")
+
+
+test_that("nomis_get_data return expected format", {
+
+  x <- nomis_get_data(id="NM_1_1", time="latest")
+
+  expect_length(x, 34)
+  expect_type(x, "list")
+  expect_true(tibble::is_tibble(x))
+
+})

tests/testthat/test_data_query.R

@@ -7,5 +7,7 @@ test_that("nomis_data_info return expected format", {
   x <- nomis_data_info()
 
   expect_length(x, 14)
-
+  expect_type(x, "list")
+  expect_true(tibble::is_tibble(x))
+
 })