File: rl_occ_country.Rd

package info (click to toggle)
r-cran-rredlist 0.5.0-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 4,968 kB
  • sloc: sh: 9; makefile: 5
file content (48 lines) | stat: -rw-r--r-- 1,429 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rl_occ_country.R
\name{rl_occ_country}
\alias{rl_occ_country}
\title{Get country occurrence by species name or ID}
\usage{
rl_occ_country(name = NULL, id = NULL, region = NULL, key = NULL,
  parse = TRUE, ...)
}
\arguments{
\item{name}{(character) A taxonomic name}

\item{id}{(character) An IUCN identifier}

\item{region}{(character) A region name, see \code{\link{rl_regions}} for
acceptable region identifiers (use the entries in the \code{identifier}
column)}

\item{key}{A IUCN API token. See \code{\link{rl_use_iucn}}.}

\item{parse}{(logical) Whether to parse to list (\code{FALSE}) or
data.frame (\code{TRUE}). Default: \code{TRUE}}

\item{...}{Curl options passed to \code{\link[crul]{HttpClient}}}
}
\value{
A list, with the data in the \code{result} slot, unless using
a function with a trailing underscore, in which case json as character
string is returned.
}
\description{
Get country occurrence by species name or ID
}
\examples{
\dontrun{
rl_occ_country('Loxodonta africana')
rl_occ_country('Fratercula arctica', region = 'europe')
rl_occ_country(id = 12392)
rl_occ_country(id = 22694927, region = 'europe')

rl_occ_country('Fratercula arctica', parse = FALSE)
rl_occ_country_('Fratercula arctica')
rl_occ_country_('Fratercula arctica', region = 'europe')
}
}
\references{
API docs at \url{http://apiv3.iucnredlist.org/api/v3/docs}
}