starting process of developing more functions, fleshing out the packa…

…ge and purpose
ropensci · Jan 19, 2018 · 61bc805 · 61bc805
1 parent f8062f7
commit 61bc805
Show file tree

Hide file tree

Showing 16 changed files with 154 additions and 26 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,11 +1,24 @@
 Package: nomisr
 Type: Package
-Title: What the Package Does in One 'Title Case' Line
-Version: 1.0
+Title: Access nomis data on UK labour market statistics with R
+Version: 0.0.0.9000
 Date: 2018-01-19
-Author: Your Name
-Maintainer: Your Name <your@email.com>
-Description: One paragraph description of what the package does as one or more full sentences.
-License: GPL (>= 2)
-Imports: Rcpp (>= 0.12.14)
+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 labour market official statistics from the nomis
+  database
+License: GPL-3
+Imports: 
+  Rcpp (>= 0.12.14),
+  jsonlite,
+  tibble
 LinkingTo: Rcpp
+RoxygenNote: 6.0.1
+Suggests: 
+  knitr,
+  rmarkdown,
+  testthat
+VignetteBuilder: knitr
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,3 +1,6 @@
-useDynLib(nomisr, .registration=TRUE)
-exportPattern("^[[:alpha:]]+")
-importFrom(Rcpp, evalCpp)
+# Generated by roxygen2: do not edit by hand
+
+export(nomis_data)
+import(jsonlite)
+import(tibble)
+importFrom(Rcpp,sourceCpp)
diff --git a/R/RcppExports.R b/R/RcppExports.R
@@ -2,6 +2,6 @@
 # Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393
 
 rcpp_hello_world <- function() {
-    .Call(`_nomisr_rcpp_hello_world`)
+    .Call('_nomisr_rcpp_hello_world', PACKAGE = 'nomisr')
 }
 
diff --git a/R/data_download.R b/R/data_download.R
@@ -0,0 +1,13 @@
+
+
+
+nomis_data_access <- function(id){
+
+  q <- jsonlite::fromJSON("https://www.nomisweb.co.uk/api/v01/dataset/NM_1_1.jsonstat.json?", flatten = T)
+
+
+}
+
+
+#results <- fromJSONstat("https://www.nomisweb.co.uk/api/v01/dataset/NM_1_1.jsonstat.json?")
+##investigate this JSONstat package further - currently 2 years since anything has been done to it, it is still the best way forward?
diff --git a/R/data_sets.R b/R/data_sets.R
@@ -0,0 +1,31 @@
+
+## retrieve all available data sets or the information available in a specific dataset based on its ID
+
+
+#' Title
+#'
+#' @param id Dataset ID
+#'
+# @return
+#' @export
+#'
+# @examples
+nomis_data <- function(id){
+
+  if(missing(id)){
+
+  query <- "/def.sdmx.json"
+
+  } else {
+
+  query <- paste0("/",id,"/def.sdmx.json")
+
+  }
+
+  df <- nomis_query_util(query)
+
+}
+
+
+
+
diff --git a/R/nomisr-package.R b/R/nomisr-package.R
@@ -1,3 +1,12 @@
+#' nomisr: Access nomis data on UK labour market statistics with R
 
+#' Documentation available at \url{https://www.nomisweb.co.uk/api/v01/help}
 
-# Docs: https://www.nomisweb.co.uk/api/v01/help
+
+#' @docType package
+#' @name nmisr
+#' @import jsonlite
+#' @import tibble
+# @useDynLib nomisr
+#' @importFrom Rcpp sourceCpp
+NULL
diff --git a/R/search.R b/R/search.R
@@ -5,11 +5,13 @@
 
 nomis_search <- function(search, keyword=FALSE){
 
-  mydata <- dplyr::if_else(keyword==FALSE,
-                           jsonlite::fromJSON(paste0("https://www.nomisweb.co.uk/api/v01/dataset/def.sdmx.json?search=*", search, "*"), flatten = TRUE),
-                           jsonlite::fromJSON(paste0("https://www.nomisweb.co.uk/api/v01/dataset/def.sdmx.json?search=keywords-", search, "*"), flatten = TRUE))
+  query <- dplyr::if_else(keyword==FALSE,
+                           paste0("/def.sdmx.json?search=*", search, "*"),
+                           paste0("/def.sdmx.json?search=keywords-", search, "*")
 
-  df <- mydata$structure$keyfamilies$keyfamily
+  )
+
+  df <- nomis_query_util(query)
 
 
 }
diff --git a/R/utils-collect.R b/R/utils-collect.R
@@ -0,0 +1,13 @@
+
+
+## utility function to download data - may need to expand as time goes on
+
+nomis_collect_util <- function(query){
+
+  q <- jsonlite::fromJSON(paste0(collect_root, query), flatten = TRUE)
+
+  #df <- tibble::as.tibble(q$structure$keyfamilies$keyfamily)
+
+  #df
+
+}
diff --git a/R/utils-query.R b/R/utils-query.R
@@ -0,0 +1,13 @@
+
+## utility function to query - may need to expand as time goes on
+
+
+nomis_query_util <- function(query){
+
+  q <- jsonlite::fromJSON(paste0(query_root, query), flatten = TRUE)
+
+  df <- tibble::as.tibble(q$structure$keyfamilies$keyfamily)
+
+  df
+
+}
diff --git a/R/utils-webroots.R b/R/utils-webroots.R
@@ -0,0 +1,9 @@
+## utility object
+
+# the basic url for all data queries
+query_root <- "https://www.nomisweb.co.uk/api/v01/dataset"
+
+# the basic url for all data downloads
+collect_root <- "https://www.nomisweb.co.uk/api/v01/dataset"
+
+p_load(rjstat)
diff --git a/README.Rmd b/README.Rmd
@@ -14,7 +14,7 @@ knitr::opts_chunk$set(
 
 # nomisr
 
-The goal of nomisr is to ...
+`nomisr` is for accessing [nomis](https://www.nomisweb.co.uk/) data on UK labour market statistics with R. 
 
 ## Installation
 

diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 nomisr
 ======
 
-The goal of nomisr is to ...
+`nomisr` is for accessing [nomis](https://www.nomisweb.co.uk/) data on UK labour market statistics with R.
 
 Installation
 ------------

diff --git a/Read-and-delete-me b/Read-and-delete-me
diff --git a/man/nmisr.Rd b/man/nmisr.Rd
diff --git a/man/nomis_data.Rd b/man/nomis_data.Rd
diff --git a/tests/testthat.R b/tests/testthat.R
@@ -0,0 +1,4 @@
+library(testthat)
+library(nomisr)
+
+test_check("nomisr")