first commit

.Rbuildignore

@@ -0,0 +1,9 @@
+^.*\.Rproj$
+^\.Rproj\.user$
+^CONDUCT\.md$
+README.Rmd
+.travis.yml
+appveyor.yml
+cran-comments.md
+NEWS.md
+man-roxygen

.gitignore

@@ -0,0 +1,5 @@
+.Rproj.user
+.Rhistory
+.RData
+oldtravis.yml
+

.travis.yml

@@ -0,0 +1,5 @@
+language: r
+notifications:
+  email:
+    on_success: change
+    on_failure: change

CONDUCT.md

@@ -0,0 +1,25 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who 
+contribute through reporting issues, posting feature requests, updating documentation,
+submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for
+everyone, regardless of level of experience, gender, gender identity and expression,
+sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or
+imagery, derogatory comments or personal attacks, trolling, public or private harassment,
+insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments,
+commits, code, wiki edits, issues, and other contributions that are not aligned to this 
+Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed 
+from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by 
+opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the Contributor Covenant 
+(http:contributor-covenant.org), version 1.0.0, available at 
+http://contributor-covenant.org/version/1/0/0/

DESCRIPTION

@@ -0,0 +1,17 @@
+Package: rredlist
+Type: Package
+Title: IUCN Red List Client
+Description: IUCN Red List client. Functions for fetching data and stuff.
+Version: 0.0.4.9300
+Authors@R: c(person("Scott", "Chamberlain", role = c("aut", "cre"),
+    email = "[email protected]"))
+License: MIT + file LICENSE
+URL: https://github.com/ropenscilabs/rredlist
+BugReports: https://github.com/ropenscilabs/rredlist/issues
+LazyData: TRUE
+Imports:
+    httr,
+    jsonlite
+Suggests:
+    testthat
+RoxygenNote: 5.0.1

LICENSE

@@ -0,0 +1,2 @@
+YEAR: 2015
+COPYRIGHT HOLDER: Scott Chamberlain

NAMESPACE

@@ -0,0 +1,32 @@
+# Generated by roxygen2: do not edit by hand
+
+export(rl_common_names)
+export(rl_common_names_)
+export(rl_countries)
+export(rl_countries_)
+export(rl_habitats)
+export(rl_habitats_)
+export(rl_measures)
+export(rl_measures_)
+export(rl_narrative)
+export(rl_narrative_)
+export(rl_regions)
+export(rl_regions_)
+export(rl_search)
+export(rl_search_)
+export(rl_sp)
+export(rl_sp_)
+export(rl_sp_category)
+export(rl_sp_category_)
+export(rl_sp_citation)
+export(rl_sp_citation_)
+export(rl_sp_count)
+export(rl_sp_count_)
+export(rl_sp_country)
+export(rl_sp_country_)
+export(rl_synonyms)
+export(rl_synonyms_)
+export(rl_threats)
+export(rl_threats_)
+import(httr)
+import(jsonlite)

R/rl_common_names.R

@@ -0,0 +1,19 @@
+#' Get species narrative information by taxon name or IUCN id
+#'
+#' @export
+#' @param name (character) Binomial taxonomic name
+#' @template all
+#' @template info
+#' @examples \dontrun{
+#' rl_common_names('Loxodonta africana')
+#' rl_common_names_('Loxodonta africana')
+#' }
+rl_common_names <- function(name = NULL, key = NULL, parse = TRUE, ...) {
+  rl_parse(rr_GET(file.path("species/common_names", name), key, ...), parse)
+}
+
+#' @export
+#' @rdname rl_common_names
+rl_common_names_ <- function(name = NULL, key = NULL, ...) {
+  rr_GET(file.path("species/common_names", name), key, ...)
+}

R/rl_countries.R

@@ -0,0 +1,18 @@
+#' Get countries
+#'
+#' @export
+#' @template all
+#' @template info
+#' @examples \dontrun{
+#' rl_countries()
+#' rl_countries_()
+#' }
+rl_countries <- function(key = NULL, parse = FALSE, ...) {
+  rl_parse(rr_GET("country/list", key, ...), parse)
+}
+
+#' @export
+#' @rdname rl_countries
+rl_countries_ <- function(key = NULL, ...) {
+  rr_GET("country/list", key, ...)
+}

R/rl_habitats.R

@@ -0,0 +1,37 @@
+#' Get species habitats by taxon name or IUCN id
+#'
+#' @export
+#' @template commonargs
+#' @template all
+#' @template info
+#' @examples \dontrun{
+#' rl_habitats('Fratercula arctica')
+#' rl_habitats('Fratercula arctica', region = 'europe')
+#' rl_habitats(id = 12392)
+#' rl_habitats(id = 22694927, region = 'europe')
+#'
+#' rl_habitats_('Fratercula arctica')
+#' rl_habitats_(id = 12392)
+#' }
+rl_habitats <- function(name = NULL, id = NULL, region = NULL, key = NULL, parse = TRUE, ...) {
+  rl_parse(rr_GET(.habitats(name, id, region), key, ...), parse)
+}
+
+#' @export
+#' @rdname rl_habitats
+rl_habitats_ <- function(name = NULL, id = NULL, region = NULL, key = NULL, ...) {
+  rr_GET(.habitats(name, id, region), key, ...)
+}
+
+.habitats <- function(name = NULL, id = NULL, region = NULL) {
+  stopifnot(xor(!is.null(name), !is.null(id)))
+  path <- if (!is.null(name)) {
+    file.path("habitats/species/name", name)
+  } else {
+    file.path("habitats/species/id", id)
+  }
+  if (!is.null(region)) {
+    path <- file.path(path, "region", region)
+  }
+  path
+}

R/rl_measures.R

@@ -0,0 +1,37 @@
+#' Get species conservation measures by taxon name or IUCN id
+#'
+#' @export
+#' @template commonargs
+#' @template all
+#' @template info
+#' @examples \dontrun{
+#' rl_measures('Fratercula arctica')
+#' rl_measures('Fratercula arctica', region = 'europe')
+#' rl_measures(id = 12392)
+#' rl_measures(id = 22694927, region = 'europe')
+#'
+#' rl_measures_('Fratercula arctica')
+#' rl_measures_(id = 22694927, region = 'europe')
+#' }
+rl_measures <- function(name = NULL, id = NULL, region = NULL, key = NULL, parse = TRUE, ...) {
+  rl_parse(rr_GET(.measures(name, id, region), key, ...), parse)
+}
+
+#' @export
+#' @rdname rl_measures
+rl_measures_ <- function(name = NULL, id = NULL, region = NULL, key = NULL, ...) {
+  rr_GET(.measures(name, id, region), key, ...)
+}
+
+.measures <- function(name = NULL, id = NULL, region = NULL) {
+  stopifnot(xor(!is.null(name), !is.null(id)))
+  path <- if (!is.null(name)) {
+    file.path("measures/species/name", name)
+  } else {
+    file.path("measures/species/id", id)
+  }
+  if (!is.null(region)) {
+    path <- file.path(path, "region", region)
+  }
+  path
+}

R/rl_narrative.R

@@ -0,0 +1,37 @@
+#' Get species narrative information by taxon name or IUCN id
+#'
+#' @export
+#' @template commonargs
+#' @template all
+#' @template info
+#' @examples \dontrun{
+#' rl_narrative('Fratercula arctica')
+#' rl_narrative('Fratercula arctica', region = 'europe')
+#' rl_narrative(id = 12392)
+#' rl_narrative(id = 22694927, region = 'europe')
+#'
+#' rl_narrative_('Fratercula arctica')
+#' rl_narrative_('Fratercula arctica', region = 'europe')
+#' }
+rl_narrative <- function(name = NULL, id = NULL, region = NULL, key = NULL, parse = TRUE, ...) {
+  rl_parse(rr_GET(.narrative(name, id, region), key, ...), parse)
+}
+
+#' @export
+#' @rdname rl_narrative
+rl_narrative_ <- function(name = NULL, id = NULL, region = NULL, key = NULL, ...) {
+  rr_GET(.narrative(name, id, region), key, ...)
+}
+
+.narrative <- function(name = NULL, id = NULL, region = NULL) {
+  stopifnot(xor(!is.null(name), !is.null(id)))
+  path <- if (!is.null(name)) {
+    file.path("species/narrative", name)
+  } else {
+    file.path("species/narrative/id", id)
+  }
+  if (!is.null(region)) {
+    path <- file.path(path, "region", region)
+  }
+  path
+}

R/rl_regions.R

@@ -0,0 +1,19 @@
+#' Get regions
+#'
+#' @export
+#' @template all
+#' @template info
+#' @examples \dontrun{
+#' rl_regions()
+#' rl_regions(parse = FALSE)
+#' rl_regions_()
+#' }
+rl_regions <- function(key = NULL, parse = TRUE, ...) {
+  rl_parse(rr_GET("region/list", key, ...), parse)
+}
+
+#' @export
+#' @rdname rl_regions
+rl_regions_ <- function(key = NULL, ...) {
+  rr_GET("region/list", key, ...)
+}

R/rl_search.R

@@ -0,0 +1,38 @@
+#' Search by taxon name or IUCN id
+#'
+#' @export
+#' @template commonargs
+#' @template all
+#' @template info
+#' @examples \dontrun{
+#' rl_search('Fratercula arctica')
+#' rl_search('Fratercula arctica', region = 'europe')
+#' rl_search(id = 12392)
+#' rl_search(id = 22694927, region = 'europe')
+#'
+#' rl_search('Fratercula arctica', parse = FALSE)
+#' rl_search_('Fratercula arctica')
+#' rl_search_('Fratercula arctica', region = 'europe')
+#' }
+rl_search <- function(name = NULL, id = NULL, region = NULL, key = NULL, parse = TRUE, ...) {
+  rl_parse(rr_GET(.search(name, id, region), key, ...), parse)
+}
+
+#' @export
+#' @rdname rl_search
+rl_search_ <- function(name = NULL, id = NULL, region = NULL, key = NULL, ...) {
+  rr_GET(.search(name, id, region), key, ...)
+}
+
+.search <- function(name = NULL, id = NULL, region = NULL) {
+  stopifnot(xor(!is.null(name), !is.null(id)))
+  path <- if (!is.null(name)) {
+    file.path("species", name)
+  } else {
+    file.path("species/id", id)
+  }
+  if (!is.null(region)) {
+    path <- file.path(path, "region", region)
+  }
+  path
+}

R/rl_sp.R

@@ -0,0 +1,21 @@
+#' Get species
+#'
+#' @export
+#' @param page (interger) Page to get. Default: 1
+#' @template all
+#' @examples \dontrun{
+#' rl_sp(page = 1)
+#' rl_sp(page = 2)
+#' rl_sp(page = 3)
+#' rl_sp(page = 3, parse = FALSE)
+#' rl_sp_(page = 3)
+#' }
+rl_sp <- function(page, key = NULL, parse = TRUE, ...) {
+  rl_parse(rr_GET(file.path("species/page", page), key, ...), parse)
+}
+
+#' @export
+#' @rdname rl_sp
+rl_sp_ <- function(page, key = NULL, ...) {
+  rr_GET(file.path("species/page", page), key, ...)
+}

R/rl_sp_category.R

@@ -0,0 +1,21 @@
+#' Get species by category
+#'
+#' @export
+#' @param category (character) 2 letter category code
+#' @template all
+#' @examples \dontrun{
+#' rl_sp_category('VU')
+#' rl_sp_category('EN')
+#' rl_sp_category('EX')
+#' rl_sp_category('EX', parse = FALSE)
+#' rl_sp_category_('EX')
+#' }
+rl_sp_category <- function(category, key = NULL, parse = TRUE, ...) {
+  rl_parse(rr_GET(file.path("species/category", category), key, ...), parse)
+}
+
+#' @export
+#' @rdname rl_sp_category
+rl_sp_category_ <- function(category, key = NULL, parse = TRUE, ...) {
+  rr_GET(file.path("species/category", category), key, ...)
+}

R/rl_sp_citation.R

@@ -0,0 +1,37 @@
+#' Get citations
+#'
+#' @export
+#' @template commonargs
+#' @template all
+#' @template info
+#' @examples \dontrun{
+#' rl_sp_citation('Balaena mysticetus')
+#' rl_sp_citation('Balaena mysticetus', region = 'europe')
+#' rl_sp_citation(id = 12392)
+#'
+#' rl_sp_citation(id = 2467, region = 'europe')
+#' rl_sp_citation(id = 2467, region = 'europe', parse = FALSE)
+#' rl_sp_citation_(id = 2467, region = 'europe')
+#' }
+rl_sp_citation <- function(name = NULL, id = NULL, region = NULL, key = NULL, parse = TRUE, ...) {
+  rl_parse(rr_GET(.sp_citation(name, id, region), key, ...), parse)
+}
+
+#' @export
+#' @rdname rl_sp_citation
+rl_sp_citation_ <- function(name = NULL, id = NULL, region = NULL, key = NULL, ...) {
+  rr_GET(.sp_citation(name, id, region), key, ...)
+}
+
+.sp_citation <- function(name = NULL, id = NULL, region = NULL) {
+  stopifnot(xor(!is.null(name), !is.null(id)))
+  path <- if (!is.null(name)) {
+    file.path("species/citation", name)
+  } else {
+    file.path("species/citation/id", id)
+  }
+  if (!is.null(region)) {
+    path <- file.path(path, "region", region)
+  }
+  path
+}