aw_data: Retrieve data from the AntWeb

Description Usage Arguments Value Examples

Description

This function allows a user to query the AntWeb database by any taxonomic rank or full species name.

Usage

1
2
3
4
5
aw_data(genus = NULL, species = NULL, scientific_name = NULL,
  georeferenced = NULL, min_elevation = NULL, max_elevation = NULL,
  type = NULL, habitat = NULL, country = NULL, min_date = NULL,
  max_date = NULL, bbox = NULL, limit = NULL, offset = NULL,
  quiet = FALSE)

Arguments

genus

An ant genus name

species

a species name

scientific_name

An easier way to pass the Genus and species name together, especially when the data are derived from other packages.

georeferenced

Default is FALSE. Set to TRUE to return only data with lat/long information. Note that this filtering takes place on the client-side, not server side.

bbox

A lat long bounding box. Format is lat,long,lat,long. Use this website: http://boundingbox.klokantech.com/ to quickly grab a bbox (set format on bottom left to csv and be sure to switch the order from long, lat, long, lat to lat, long, lat, long) Just set the format on the bottom left to CSV.

type

A holotype

habitat

A fuzzy search by any habitat

country

A country name

min_date

A lower date bound in the format yyyy-mm-dd

max_date

An upper date bound in the format yyyy-mm-dd

min_elevation

A lower elevation bound

max_elevation

An upper elevation bound

limit

A numeric value to limit number of records

offset

An offset best used with limit as a way to paginate records

quiet

If true, any informative messages will be suppressed

Value

data.frame

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# data <- aw_data(genus = "acanthognathus", species = "brevicornis")
# data3 <- aw_data(genus = "acanthognathus", species = "brevicornis", georeferenced = TRUE)
# data2 <- aw_data(scientific_name = "acanthognathus brevicornis")
# sandstone <- aw_data(genus = "Aphaenogaster", habitat = "sandstone")
# data_genus_only <- aw_data(genus = "acanthognathus", limit = 25)
# leaf_cutter_ants  <- aw_data(genus = "acromyrmex")
# data  <- aw_data(genus = "Technomyrmex", bbox = '37.77,-122.46,37.76,-122.47')
# Search just using a bounding box
# data  <- aw_data(bbox = '37.77,-122.46,37.76,-122.47')
# Search by a elevation band
# aw_data(min_elevation = 1500, max_elevation = 2000)
# When you throw a really specimen rich band like below, you'll get a huge number of requests.
# Only the first 1000 records will download first.
# aw_data(min_elevation = 200, max_elevation = 400)
# aw_data(min_date = '1980-01-01', max_date = '1981-01-01')
# fail <- aw_data(scientific_name = "auberti levithorax") # This should fail gracefully

Example output



AntWeb documentation built on May 2, 2019, 3:43 p.m.