get_by_age: Return occurrences for all taxa within a specified time...

In EarthLifeConsortium/earthlife: Biodiversity in space and time. A wrapper for the EarthLife Consortium API.

Description

A wrapper for the Composite API, returning all records from both databases.

Usage

get_by_age(x, ageunit = "Mya", timerule = "contain", timebuffer = "20",
  ...)

Arguments

x	An (optional) age range c(agemin, agemax).
ageunit	The age units for the age range. By default "ma" (millions of years ago), accepts "kya" (thousands of years ago) and "ybp" (years before present).
timerule	Resolve time overlap using the appropriate rule: contain (records are fully within range), major (records at least 50% within), overlap (records overlap), or buffer (fully contained, with a buffer of - default - 20%).
timebuffer	(optional) for use with timerule == "buffer", the temporal buffer around the defined age range in x.
...	Other parameters to be passed into the API, described at https://training.paleobiodb.org/comp1.0.

Value

More details on the use of these parameters can be obtained from https://training.paleobiodb.org/comp1.0/.

A list of class 'occurrence' and 'list'. The list is composed of two elements:

records	The complete listing of taxon occurrences.
meta	Metadata for the search.

The records object is a data.frame

collection_name	Site or collection unit name for the record.
lng	Collection site longitude.
lat	Collection site latitude.
accepted_name	The taxon name.
max_age	The oldest of all sample ages (in calendar years before present) in the dataset.
min_age	The youngest of all sample ages (in calendar years before present) in the dataset.
age_unit	The units for age (by default "Mya").
database	The database from which the record was obtained.
occurrence_no	The numeric ID for the record within the parent database.
dataset_no	For records within Neotoma, the numeric ID of the dataset from which the sample was obtained.
accepted_no	The numeric identifier for the taxon name from the parent database.
collection_no	The numeric identifier for the collection within the parent database.
country	The country within which the sample is found (if known).
state	The state (when known) within the identified country.

Author(s)

Simon J. Goring [e-mail]

References

EarthLife Consortium: http://earthlifeconsortium.org/ API Reference: https://training.paleobiodb.org/comp1.0

Examples

## Not run: 
# Search for sites with "Canis" fossils.
holocene_snap <- get_by_age(x = c(12000, 11500), ageunit = "ybp", timerule = "contain", base_name = "")

# Limit searches to North America (undocumented use of \code{bbox})


## End(Not run)

EarthLifeConsortium/earthlife documentation built on May 6, 2019, 3:10 p.m.