wm_record {worrms} | R Documentation |
Get complete AphiaRecord for an AphiaID
Description
Get complete AphiaRecord for an AphiaID
Usage
wm_record(id, ...)
wm_record_(id = NULL, name = NULL, ...)
Arguments
id |
(numeric/integer) an AphiaID. For |
... |
named curl options. see |
name |
(character) one or more taxonomic names. optional |
Value
A named list. When using underscore method, each output is named by the input ID, and can be separated by the list names
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.
Note
wm_record_
is defunct, wm_record
can do plural requests now
Examples
## Not run:
wm_record(id = 105706)
wm_record(id = c(105706, 126436))
wm_record_(id = c(105706, 126436))
## End(Not run)