npn_species: Get Species

View source: R/npn_get_species.R

npn_speciesR Documentation

Get Species

Description

Returns a complete list of all species information of species represented in the NPN database.

Returns information about a species based on the NPN's unique ID for that species

Search for species by state

Search NPN species information using a number of different parameters, which can be used in conjunction with one another, including: - Species on which a particular group or groups are actually collecting data - What species were observed in a given date range - What species were observed at a particular station or stations

Usage

npn_species(...)

npn_species_id(ids, ...)

npn_species_state(state, kingdom = NULL, ...)

npn_species_search(
  network = NULL,
  start_date = NULL,
  end_date = NULL,
  station_id = NULL,
  ...
)

Arguments

...

Curl options passed on to GET

ids

List of species ids for which to retrieve information

state

A US postal state code to filter results.

kingdom

Filters results by taxonomic kingdom. Takes either 'Animalia' or 'Plantae'.

network

filter species based on a list of unique identifiers of NPN groups that are actually observing data on the species. Takes a list of IDs

start_date

filter species by date observed. This sets the start date of the date range and must be used in conjunction with end_date

end_date

filter species by date observed. This sets the end date of the date range and must be used in conjunction with start_date

station_id

filter species by a list of unique site identifiers

Value

A data frame with information on species in the NPN database and their IDs.

A data frame with information on species in the NPN database and their IDs, filtered by the species ID parameter.

A data frame with information on species in the NPN database whose distribution includes a given state.

A data frame with information on species in the NPN database filtered by partner group, dates and station/site IDs.

Examples

## Not run: 
npn_species()
npn_species_id(ids = 3)

## End(Not run)
## Not run: 
npn_species_state(state = "AZ")
npn_species_state(state = "AZ", kingdom = "Plantae")

## End(Not run)

rnpn documentation built on Aug. 30, 2023, 5:19 p.m.