Skip to contents

Species search

Source: R/ns_search_spp.R
ns_search_spp.Rd

Species search

Usage

ns_search_spp(
  text = NULL,
  text_adv = NULL,
  status = NULL,
  location = NULL,
  species_taxonomy = NULL,
  record_subtype = NULL,
  modified_since = NULL,
  page = NULL,
  per_page = NULL,
  ...
)

Arguments

text

(character) basic text search, equiavalent to text_adv with matchAgainst="allNames" and operator="similarTo"

text_adv

(list) advanced search, must specify the following three elements: searchToken, matchAgainst, and operator. see https://explorer.natureserve.org/api-docs/#_advanced_text_search_parameter

status

(character) conservation status, one of G1, G2, G3, G4, G5, GH, GX, GNR, GNA, GU. case insensitive

location

(list) location, country and sub-country. specify either nation OR nation and subnation. each expects a two-letter ISO code

species_taxonomy

(list) species taxonomy. either a list with level and scientificTaxonomy (a scientific name), or with just informalTaxonomy (a vernacular name). possible level values: "kingdom", "phylum", "class", "order", "family", "genus"

record_subtype

(character) limit results by record sub-type, one of: "class", "subclass", "formation", "division", "macrogroup", "group", "alliance", "association", "terrestrial_ecological_system"

modified_since

(character) search for records modified since a given time. value must be a date and time with a UTC offset in ISO 8601 format. optional

page

(integer) Zero-indexed page number; default: 0. optional

per_page

(integer) Records per page; default: 20. optional

...

Curl options passed on to verb-GET

References

https://explorer.natureserve.org/api-docs/

See also

Other search: ns_search_comb(), ns_search_eco()

Examples

if (FALSE) { # \dontrun{
ns_search_spp(text = "robin")
ns_search_spp(text_adv = list(searchToken = "bird", 
  matchAgainst = "allNames", operator="similarTo"))
ns_search_spp(status = "G1")
ns_search_spp(location = list(nation = "US"))
ns_search_spp(location = list(nation = "US", subnation = "VA"))
ns_search_spp(species_taxonomy = list(scientificTaxonomy = "Animalia", level = "kingdom"))
ns_search_spp(species_taxonomy = list(informalTaxonomy = "birds"))
ns_search_spp(record_subtype = "macrogroup")
ns_search_spp(modified_since = "2020-04-30T00:00:00+0000")
ns_search_spp(page = 0, per_page = 2)
} # }