worms_children: Children search of WoRMS data

View source: R/worms_children.R

worms_childrenR Documentation

Children search of WoRMS data

Description

Children search of WoRMS data

Usage

worms_children(
  ids = NULL,
  offset = NULL,
  marine_only = 1,
  opts = NULL,
  iface = NULL,
  ...
)

Arguments

ids

(numeric) One or more WoRMS AphidID's for a taxon.

offset

Starting record number, when retrieving next chunk of (50) records. Default=1.

marine_only

(logical) Include results from marine taxa only. Default: TRUE.

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.

Value

A list of data.frame's, named by the input Aphia ids

Examples

## Not run: 
worms_children(ids=106135)
worms_children(ids=c(106135,159283))
out <- worms_children(ids=c(106135,159283))
lapply(out, head)

# to bind outputs together from multiple taxa
do.call(rbind, out)
## or with plyr::rbind.fill
do.call(rbind.fill, out)

## End(Not run)

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