fix #19 add nsr datasets, throw warnings when country, state/province…

… name not in accepted set

DESCRIPTION

@@ -8,7 +8,7 @@ Description: Get species origin data (whether species is native/invasive) from t
     (<http://bien.nceas.ucsb.edu/bien/tools/nsr/nsr-ws/>), Integrated Taxonomic
     Information Service (<http://www.itis.gov/>), and Global Register of
     Introduced and Invasive Species (<http://www.griis.org/>).
-Version: 0.2.5.9110
+Version: 0.2.6.9110
 Authors@R: c(
     person("Scott", "Chamberlain", role = c("aut", "cre"), email = "myrmecocystus@gmail.com"),
     person("Ignasi", "Bartomeus", role = "aut", email = "nacho.bartomeus@gmail.com")
@@ -17,6 +17,8 @@ License: MIT + file LICENSE
 URL: https://github.com/ropensci/originr
 BugReports: https://github.com/ropensci/originr/issues
 Roxygen: list(markdown = TRUE)
+LazyLoad: yes
+LazyData: yes
 Imports:
     crul (>= 0.5.2),
     jsonlite (>= 1.5),

R/globals.R

@@ -0,0 +1,3 @@
+if (getRversion() >= "2.15.1") {
+  utils::globalVariables(c('nsr_countries','nsr_pol_divisions'))
+}

R/nsr.R

@@ -5,23 +5,42 @@
 #' @param country (character) A country name. required.
 #' @param stateprovince (character) A state or province name
 #' @param countyparish (character) A county or parish name
-#' @param ... curl options passed on to \code{\link[crul]{HttpClient}}
-#' @references \url{http://bien.nceas.ucsb.edu/bien/tools/nsr/nsr-ws/}
+#' @param ... curl options passed on to [crul::HttpClient]
+#' @references http://bien.nceas.ucsb.edu/bien/tools/nsr/nsr-ws/
 #' @details Currently, only one name is allowed per request. We loop internally
 #' over a list of length > 1, but this will still be slow due to only 1
 #' name per request.
 #'
 #' Note that this service can be quite slow.
+#' 
+#' @section political names:
+#' 
+#' - `nsr_countries`: is a vector of country names that we use to check
+#' your country names
+#' - `nsr_pol_divisions`: is a data.frame of country names and state/province
+#' names that we used to check your parameter inputs - these are for checklists 
+#' that NSR has complete coverage for
+#' 
 #' @examples \dontrun{
-#' nsr("Pinus ponderosa", "United States")
-#' nsr(c("Pinus ponderosa", "Poa annua"), "United States")
+#' nsr("Pinus ponderosa", country = "United States")
+#' nsr(c("Pinus ponderosa", "Poa annua"), country = "United States")
 #' splist <- c("Pinus ponderosa", "Poa annua", "bromus tectorum", "Ailanthus altissima")
 #' nsr(splist, country = "United States")
+#' nsr(splist, country = "United States", stateprovince = "California")
 #'
 #' # curl options
 #' nsr("Pinus ponderosa", "United States", verbose = TRUE)
 #' }
 nsr <- function(species, country, stateprovince = NULL, countyparish = NULL, ...) {
+  if (!country %in% nsr_countries) {
+    warning("country ", country, " not in the NSR list of countries")
+  }
+  if (!is.null(stateprovince)) {
+    if (!stateprovince %in% nsr_pol_divisions$state_province) {
+      warning("state/province ", stateprovince, 
+        " not in the NSR list of state/provinces")
+    }
+  }
   tmp <- lapply(species, function(z) {
     args <- orc(list(format = 'json', species = z, country = country,
                      stateprovince = stateprovince, countyparish = countyparish))

R/originr-package.R

@@ -21,3 +21,24 @@
 #'  \item Integrated Taxonomic Information Service (http://www.itis.gov/)
 #' }
 NULL
+
+#' Vector of country names for use with NSR
+#'
+#' @format A vector of countries of length 251
+#' @name nsr_countries
+#' @docType data
+#' @keywords data
+NULL
+
+#' NSR political divisions
+#'
+#' @format A data frame with 73 rows and 2 variables:
+#' \describe{
+#'   \item{country}{Country name}
+#'   \item{state_province}{State or province name}
+#' }
+#' 
+#' @name nsr_pol_divisions
+#' @docType data
+#' @keywords data
+NULL

tests/testthat/test-nsr.R

@@ -13,6 +13,6 @@ test_that("nsr works", {
 test_that("fails well", {
   skip_on_cran()
 
-  expect_error(nsr(), "argument \"species\" is missing")
+  expect_error(nsr(), "argument \"country\" is missing")
   expect_equal(NROW(nsr(species = "adadfd", country = "United States")), 1)
 })