Merge pull request #3 from QuantGov/dev

final codebase with all the fixes and cran compliances

Author: gadia-aayush

DESCRIPTION

@@ -1,10 +1,17 @@
 Type: Package
 Package: regcensus
-Title: Accessing Data from the RegCensusAPI
+Title: Accessing Data from the 'RegCensusAPI'
 Version: 1.0.0
-Author: QuantGov
-Maintainer: QuantGov <info@quantgov.org>
-Description: Allowing users to access data from the RegCensusAPI. The RegCensusAPI is an API client that connects to the RegData regulatory restrictions data by the Mercatus Center at George Mason University. RegData uses machine learning algorithms to quantify the number of regulatory restrictions in a jurisdiction. You can find out more about RegData from 'QuantGov website' <https://www.quantgov.org>.
+Authors@R: c(
+    person("Jonathan", "Nelson", , "jnelson@mercatus.gmu.edu", 
+            role = c("aut", "cre")),
+    person("Thurston", "Powers", , "tpowers@mercatus.gmu.edu", 
+            role = c("aut")),
+    person("Aayush", "Gadia", , "agadia@mercatus.gmu.edu", 
+            role = c("aut")),
+    person("Mercatus Center", email = "info@quantgov.org",
+            role = c("cph", "fnd")))
+Description: Allowing users to access data from the 'RegCensusAPI'. The 'RegCensusAPI' is an API client that connects to the 'RegData' regulatory restrictions data by the 'Mercatus Center' at 'George Mason University'. 'RegData' uses machine learning algorithms to quantify the number of regulatory restrictions in a jurisdiction. You can find out more about 'RegData' from 'QuantGov website' <https://www.quantgov.org>.
 License: MIT+ file LICENSE
 URL: https://github.com/QuantGov/regcensus-api-client-R
 BugReports: https://github.com/QuantGov/regcensus-api-client-R/issues

R/agency_url.R

@@ -5,7 +5,7 @@
 #' @param keyword search for keyword in agency name
 #' @return url as a string
 #' @examples
-#' agency_url(jurisdiction_id = 38, keyword = "test_word")
+#' \dontrun{agency_url(jurisdiction_id = 38, keyword = "test_word")}
 #' @import jsonlite
 #' @import stringr
 #' @import httr
@@ -20,7 +20,7 @@ agency_url <- function(jurisdiction_id, keyword) {
   } else if (!is.null(jurisdiction_id)) {
     url_call <- paste0(url, "/agencies?", "jurisdiction=", jurisdiction_id)
   } else {
-    print("Must include either 'jurisdiction_id' or 'keyword.'")
+    message("Must include either 'jurisdiction_id' or 'keyword.'")
     return()
   }
   return(url_call)

R/get_agencies.R

@@ -6,7 +6,7 @@
 #' @param verbose prints out the url of the API call, default value of 0
 #' @return Returns pandas dataframe with the metadata
 #' @examples
-#' get_agencies(jurisdiction_id = 38, keyword = "test")
+#' \dontrun{get_agencies(jurisdiction_id = 38, keyword = "test")}
 #' @import jsonlite
 #' @import stringr
 #' @import httr
@@ -17,7 +17,7 @@
 get_agencies <- function(jurisdiction_id = NULL, keyword = NULL, verbose = 0) {
   url_call <- agency_url(jurisdiction_id, keyword)
   if (verbose) {
-    print(paste0("API call: ", url_call))
+    message(paste0("API call: ", url_call))
   }
   output <- clean_columns(fromJSON(content(GET(url_call), as = "parsed")))
   return(output)

R/get_datafinder.R

@@ -6,7 +6,7 @@
 #' @return Returns dataframe with the series and years available,
 #'          along with the endpoints to access the data
 #' @examples
-#' get_datafinder(jurisdiction = 38)
+#' \dontrun{get_datafinder(jurisdiction = 1)}
 #' @import httr
 #' @import jsonlite
 #' @import stats

R/get_document_values.R

@@ -35,10 +35,10 @@
 #'                default value is 0
 #' @return Returns pandas dataframe with the metadata
 #' @examples
-#' get_document_values(
+#' \dontrun{get_document_values(
 #'   series = 33, jurisdiction = 38,
 #'   year = 2018, label = "111"
-#' )
+#' )}
 #' @import jsonlite
 #' @import stringr
 #' @import httr

R/get_documentation.R

@@ -5,7 +5,7 @@
 #'          documentation, the source name, source citation,
 #'          source url and documentation.
 #' @examples
-#' get_documentation()
+#' \dontrun{get_documentation()}
 #' @import jsonlite
 #' @import stringr
 #' @import httr

R/get_documents.R

@@ -9,7 +9,7 @@
 #' @param verbose prints out the url of the API call, default value of 0
 #' @return Returns pandas dataframe with the metadata
 #' @examples
-#' get_documents(jurisdiction_id = 38, date = 2018)
+#' \dontrun{get_documents(jurisdiction_id = 38, date = 2022)}
 #' @import jsonlite
 #' @import stringr
 #' @import httr
@@ -20,18 +20,18 @@
 get_documents <- function(document_id = NULL, jurisdiction_id = NULL,
                           date = NULL, document_type = 1, verbose = 0) {
   if (!is.null(document_id)) {
-    message <- paste0("document_id is no longer accessible as of version 1.0.",
-              " Use previous version of API or use jurisdiction_id",
-              " and date combination")
-    print(message)
+    text <- paste0("document_id is no longer accessible as of version 1.0.",
+                      " Use previous version of API or use jurisdiction_id",
+                      " and date combination")
+    message(text)
     return()
   } else if (!is.null(jurisdiction_id) && !is.null(date)) {
     return(get_values(series = 1, jurisdiction = jurisdiction_id,
                       year = date,
                       document_type = document_type,
                       summary = FALSE))
   } else {
-    print("Must include jurisdiction_id and date")
+    message("Must include jurisdiction_id and date")
     return()
   }
 }

R/get_endpoint.R

@@ -11,10 +11,10 @@
 #' @return Returns the endpoint, e.g. '/state-summary' for summary-level state
 #'         data
 #' @examples
-#' get_endpoint(
+#' \dontrun{get_endpoint(
 #'   series = c(28, 33, 36), jurisdiction = 38,
 #'   year = c(1970, 2003, 2004, 2018), document_type = 1
-#' )
+#' )}
 #' @import jsonlite
 #' @import stringr
 #' @import httr

R/get_industries.R

@@ -7,7 +7,7 @@
 #' @param verbose prints out the url of the API call, default value of 0
 #' @return Returns pandas dataframe with the metadata
 #' @examples
-#' get_industries()
+#' \dontrun{get_industries()}
 #' @import jsonlite
 #' @import stringr
 #' @import httr
@@ -19,7 +19,7 @@ get_industries <- function(keyword = NULL, label_level = 3,
                            label_source = NULL, verbose = 0) {
   url_call <- industries_url(keyword, label_level, label_source)
   if (verbose) {
-    print(paste0("API call: ", url_call))
+    message(paste0("API call: ", url_call))
   }
   output <- clean_columns(fromJSON(content(GET(url_call), as = "parsed")))
   return(output)

R/get_jurisdictions.R

@@ -4,7 +4,7 @@
 #' @param verbose prints out the url of the API call, default value of 0
 #' @return Returns pandas dataframe with the metadata
 #' @examples
-#' get_jurisdictions()
+#' \dontrun{get_jurisdictions()}
 #' @import jsonlite
 #' @import stringr
 #' @import httr
@@ -15,7 +15,7 @@
 get_jurisdictions <- function(verbose = 0) {
   url_call <- jurisdictions_url()
   if (verbose) {
-    print(paste0("API call: ", url_call))
+    message(paste0("API call: ", url_call))
   }
   output <- clean_columns(fromJSON(content(GET(url_call), as = "parsed")))
   return(output)