Skip to contents

Retrieve available references for a given taxon concept.

Usage

spp_references(
  taxon_id,
  raw = FALSE,
  token = NULL,
  verbose = TRUE,
  pause = 1,
  ...
)

Arguments

taxon_id

a vector of character strings containing species' taxon concept identifiers (see spp_taxonconcept()).

raw

a logical. Should raw data be returned?

token

a character string containing the authentification token, see https://api.speciesplus.net/documentation. Default is set to NULL and requires the environment variable SPECIESPLUS_TOKEN to be set directly in Renviron. Alternatively, set_token() can be used to set SPECIESPLUS_TOKEN for the current session.

verbose

a logical. Should extra information be reported on progress?

pause

a duration (in second) to suspend execution for (see Sys.sleep()). This was added cause the web API returns a 404 error too many requests in a short time interval.

...

Further named parameters, see httr::GET().

Value

If raw is set to TRUE then an object of class spp_raw (or spp_raw_multi if length(taxon_id) > 1) is returned which is essentially a list of lists (see option as = 'parsed' in httr::content()). Otherwise, an object of class spp_refs (or spp_refs_multi if length(taxon_id) > 1) is returned which is a list of one data frame:

  • references that includes the identifier of the reference and the corresponding citation.

Examples

# \donttest{
res1 <- spp_references(taxon_id = '4521')
#> 
#>     `SPECIESPLUS_TOKEN` env var has not been set yet.
#>     A token is required to use the species + API, see
#>     https://api.speciesplus.net/documentation
#>     
#> Enter your token without quotes: 
#> Error in set_token(): No token has been provided.
res2 <- spp_references(c('4521', '3210', '10255'))
#> 
#>     `SPECIESPLUS_TOKEN` env var has not been set yet.
#>     A token is required to use the species + API, see
#>     https://api.speciesplus.net/documentation
#>     
#> Enter your token without quotes: 
#> Error in set_token(): No token has been provided.
res3 <- spp_references(taxon_id = '4521', raw = TRUE, verbose = FALSE,
 config = httr::progress())
#> 
#>     `SPECIESPLUS_TOKEN` env var has not been set yet.
#>     A token is required to use the species + API, see
#>     https://api.speciesplus.net/documentation
#>     
#> Enter your token without quotes: 
#> Error in set_token(): No token has been provided.
# }