R: Get a IUCN Redlist taxon

get_iucn {taxize} | R Documentation

## Get a IUCN Redlist taxon

### Description

Get a IUCN Redlist taxon

### Usage

    get_iucn(x, verbose = TRUE, key = NULL, ...)

    as.iucn(x, check = TRUE, key = NULL)

    ## S3 method for class 'iucn'
    as.iucn(x, check = TRUE, key = NULL)

    ## S3 method for class 'character'
    as.iucn(x, check = TRUE, key = NULL)

    ## S3 method for class 'list'
    as.iucn(x, check = TRUE, key = NULL)

    ## S3 method for class 'numeric'
    as.iucn(x, check = TRUE, key = NULL)

    ## S3 method for class 'data.frame'
    as.iucn(x, check = TRUE, key = NULL)

    ## S3 method for class 'iucn'
    as.data.frame(x, ...)

### Arguments

`x` | (character) A vector of common or scientific names
`verbose` | logical; should progress be printed?
`key` | (character) required. you IUCN Redlist API key. See `rredlist-package` for help on authenticating with IUCN Redlist
`...` | Ignored
`check` | (logical) Check if ID matches any existing on the DB, only used in `as.iucn`

### Details

There is no underscore method, because there's no real search for IUCN, that is, where you search for a string, and get back a bunch of results due to fuzzy matching. If that exists in the future we'll add an underscore method here.

IUCN ids only work with `synonyms` and `sci2comm` methods.

### Value

A vector of taxonomic identifiers as an S3 class.

Comes with the following attributes:

- match (character) - the reason for NA, either 'not found', 'found' or if `ask = FALSE` then 'NA due to ask=FALSE')

- name (character) - the taxonomic name, which is needed in `synonyms` and `sci2comm` methods since they internally use rredlist functions which require the taxonomic name, and not the taxonomic identifier

- uri (character) - The URI where more information can be read on the taxon - includes the taxonomic identifier in the URL somewhere

multiple_matches and pattern_match do not apply here as in other `get_*` methods since there is no IUCN Redlist search, so you either get a match or you do not get a match.

### See Also

Other taxonomic-ids: `get_boldid`, `get_colid`, `get_eolid`, `get_gbifid`, `get_ids`, `get_natservid`, `get_nbnid`, `get_tolid`, `get_tpsid`, `get_tsn`, `get_uid`, `get_wiki`, `get_wormsid`

### Examples

    ## Not run:
    get_iucn(x = "Branta canadensis")
    get_iucn(x = "Branta bernicla")
    get_iucn(x = "Panthera uncia")

    # as coercion
    as.iucn(22732)
    as.iucn("22732")
    (res <- as.iucn(c(22679946, 22732, 22679935)))
    data.frame(res)
    as.iucn(data.frame(res))

    ## End(Not run)

[Package taxize version 0.9.0 Index]