R: Get vernacular names from an AphiaID

wm_common_id {worrms} | R Documentation

## Get vernacular names from an AphiaID

### Description

Get vernacular names from an AphiaID

### Usage

    wm_common_id(id, ...)

    wm_common_id_(id = NULL, name = NULL, ...)

### Arguments

`id` | (numeric/integer) an AphiaID. For `wm_common_id` it's required and must be `length(id) = 1`, for `wm_common_id_` it's optional and can be `length(id) >= 1`
`...` | named curl options. see `curl_options`
`name` | (character) one or more taxonomic names. optional

### Value

A tibble/data.frame. when using underscore method, outputs from each input are binded together, but can be split by `id` column

### Singular vs. plural

Of the two sister functions, the one without the underscore is the original function that wraps the relavant WoRMS API method - and only accepts one thing (i.e., name or AphiaID) per request.

The sister function with the underscore at the end is the plural version, accepting more than one input. Internally this function loops over the non-underscore method, and labels output (whether it's a list or data.frame rows) with the input names or IDs so that you can easily parse output by your inputs.

### Examples

    ## Not run:
    wm_common_id(id = 105706)
    wm_common_id(id = 156806)
    wm_common_id(id = 397065)

    wm_common_id_(id = c(105706, 156806, 397065))
    nms <- c("Rhincodontidae", "Mesodesma deauratum", "Cryptomya californica")
    wm_common_id_(name = nms)

    ## End(Not run)

[Package worrms version 0.2.8 Index]