View source: R/spp_distributions.R
spp_distributions | R Documentation |
Retrieve distributions data available for a given taxon concept for which the the taxon identifier is known.
spp_distributions( taxon_id, language = "en", raw = FALSE, token = NULL, verbose = TRUE, pause = 1, ... )
taxon_id |
a vector of character strings containing species'
taxon concept identifiers (see |
language |
vector of character strings indicating the language for the
names of distributions, values are taken among |
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
|
verbose |
a logical. Should extra information be reported on progress? |
pause |
a duration (in second) to suspend execution for (see
|
... |
Further named parameters, see |
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_distr
(or spp_distr_multi
if
length(taxon_id) > 1
) is returned which is a list of two data frames:
distributions
: lists distributions for a given taxon concept,
references
: lists the corresponding references.
In case taxon_id
includes several elements
https://api.speciesplus.net/documentation/v1/distributions/index.html
## Not run: # this calls will only work if a token is set and valid res1 <- spp_distributions(taxon_id = '4521') res2 <- spp_distributions(taxon_id = c('4521', '3210', '10255')) res3 <- spp_distributions(taxon_id = '4521', raw = TRUE) res4 <- spp_distributions(taxon_id = '4521', language = 'fr', verbose = FALSE, config = httr::progress()) ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.