get_obis_recs: Query OBIS for occurence data

Description Usage Arguments Value Examples

View source: R/obis-api.R

Description

Query OBIS for occurence data

Usage

1
2
3
4
5
6
7
8
9
get_obis_recs(
  sp_id,
  validate_sp_id = FALSE,
  fields = c("decimalLongitude", "decimalLatitude", "minimumDepthInMeters",
    "maximumDepthInMeters", "depth", "eventDate", "year", "month", "scientificName",
    "aphiaID"),
  geometry = NULL,
  ignore_failures = FALSE
)

Arguments

sp_id

a valid WoRMS aphiaID

validate_sp_id

whether to check for validity of aphiaID on OBIS

fields

fields to return from OBIS query. Defaults to c("decimalLongitude", "decimalLatitude","minimumDepthInMeters", "maximumDepthInMeters", "depth", "eventDate", "year", "month", "scientificName", "aphiaID")

geometry

an sf object. Queries will be faster if the geometry is simple and restricted in space.

ignore_failures

whether to through an error or return NULL for queries that return no obis records.

Value

a tibble of OBIS occurence records for sp_id.

Examples

1
get_obis_recs(sp_id = 325567)

annakrystalli/OBIShmpr documentation built on Oct. 4, 2020, 6:37 a.m.