rvertnet (version 0.0-5)

vertlocations: Retrieve locations and number of occurrence records for an organism from VertNet v2 portals.

Description

Retrieve locations and number of occurrence records for an organism from VertNet v2 portals.

Usage

vertlocations(key = "r_B68F3", grp = "fish", t = NULL,
    l = NULL, c = NULL, d = NULL, q = NULL, p = NULL,
    m = NULL, url = NULL)

Arguments

key

API Key is required to run any query

grp

VertNet group to query. Currently available oprions fish, bird and herp. Default fish.

t

Taxon scientific and family names. It supports the 'OR' operator.

l

Location country, continent, county, ocean, island, state, province and locality. It supports the 'OR' operator.

c

Catalog Number and/or Institution Code. It supports the 'OR' operator.

d

Year or years the occurrence was collected. Date Ranges must be in yyyy-yyyy format.

q

Terms of interest that may be in the remarks, notes, scientific name, collector, preparation type, location fields or elsewhere in the occurrence. It supports the 'OR' operator.

p

Geometric query in well-known text (WKT) format. Limited to 250 vertices or 10,000 characters. Note that the Map parameter and the Geometry paramter are mutually exclusive. If both are submitted, the Map parameter will be ignored.

m

Geographic area defined by one of the available maps. Maps are designated by MapIDs ref AvailableMaps function

url

The VertNet url for the function (should be left to default).

Value

• Dataframe of search results OR prints "No records found" if no matches.

Examples

# Taxon
vertlocations(t="notropis")
vertlocations(t="notropis or nezumia")
vertlocations(t="Blenniidae")

# Location
vertlocations(l="country:india")
vertlocations(l="alabama or gulf of mexico")
vertlocations(l="africa", grp="bird")

# Catalog Number/Institution Code
vertlocations(c="TU 1")
vertlocations(c="mnhn or usnm")
vertlocations(c="ku 29288 or tu 66762")

# Date Range
vertlocations(d="2000-2000")
vertlocations(d="1950-1975")

# Other keywords
vertlocations(q="larva")
vertlocations(q="ethanol or EtOH")

# Geometry
vertlocations(p="POLYGON((-93.998292265615 32.615318339629,-92.471192656236 32.606063985828,-92.635987578112 31.235349580893,-90.988038359361 31.19776691287,-90.955079374988 30.395621231989,-93.94336062499 30.386144489302,-93.998292265615 32.615318339629))")

# Map
vertlocations(m=14)

# Wrong name
vertlocations(t="notropisz")