worms_records: Get records by ID, scientific name, common name, date, worms...

In ropensci/taxizesoap: Taxonomic Information from Around the Soap Web

Get records by ID, scientific name, common name, date, worms id, or external id.

Description

Get records by ID, scientific name, common name, date, worms id, or external id.

Usage

worms_records(
  scientific = NULL,
  common = NULL,
  ids = NULL,
  extids = NULL,
  like = NULL,
  type = NULL,
  fuzzy = FALSE,
  marine_only = 1,
  offset = NULL,
  startdate = NULL,
  enddate = NULL,
  opts = NULL,
  iface = NULL,
  ...
)

Arguments

scientific	(character) A scientific name.
common	(character) A common name.
ids	(numeric) One or more WoRMS AphidID's for a taxon.
extids	(integer) External identifier.
like	(logical) Add a percent sign after the ScientificName (SQL LIKE function). Default=TRUE
type	Type of external identifier. Should be one of bold, dyntaxa, eol, fishbase, iucn, lsid, ncbi, or tsn.
fuzzy	(logical) Use fuzzy matching or not. If TRUE, we use the WoRMS methods matchAphiaRecordsByNames() internally for fuzzy/near matching. If FALSE, we use the WoRMS method getAphiaRecords().
marine_only	(logical) Include results from marine taxa only. Default=TRUE.
offset	Starting record number, when retrieving next chunk of (50) records. Default=1.
startdate	ISO 8601 formatted start date(time). Default=today(). i.e. 2014-08-04T15:57:54+00:00
enddate	ISO 8601 formatted start date(time). Default=today(). i.e. 2014-08-04T15:57:54+00:00
opts	(character) a named list of elements that are passed to the curlPerform function which actually invokes the SOAP method. These options control aspects of the HTTP request, including debugging information that is displayed on the console, e.g. .opts = list(verbose = TRUE)
iface	Interface to WoRMS SOAP API methods. By default we use a previously created object. If you want to create a new one, use worms_gen_iface, assign the output to an object, then pass it into any worms_* function. in the iface parameter.
...	Further args passed on to SSOAP::.SOAP.

Details

Parameter type should be one of the following values:

• bold: Barcode of Life Database (BOLD) TaxID

• dyntaxa: Dyntaxa ID

• eol: Encyclopedia of Life (EoL) page identifier

• fishbase: FishBase species ID

• iucn: IUCN Red List Identifier

• lsid: Life Science Identifier

• ncbi: NCBI Taxonomy ID (Genbank)

• tsn: ITIS Taxonomic Serial Number

Examples

## Not run: 
worms_records(scientific='Salmo')
worms_records(scientific=c('Salmo','Aphanius'))
worms_records(scientific='Liopsetta glacialis')
worms_records(common='salmon')
worms_records(common=c('salmon','char'))
worms_records(startdate='2014-06-01T00:00:00', enddate='2014-06-02T00:00:00')
worms_records(ids=1080)
worms_records(extids=6830, type='ncbi')

worms_records(scientific="Holothuria edulis")
worms_records(scientific="Holothuria edulis", fuzzy=TRUE)
worms_records(scientific="Holothuria (Halodeima) edulis")

worms_records(scientific='Scotoplanes')

worms_records(scientific='Salmo', offset=51)

## End(Not run)

ropensci/taxizesoap documentation built on May 18, 2022, 7:33 p.m.