specieslist {ALA4R}R Documentation

Get list of taxa and their occurrence counts

Description

Retrieve a list of taxa matching a search query, within a spatial search area, or both

Usage

specieslist(taxon, wkt, fq)

Arguments

taxon

string: Text of taxon, e.g. "Macropus rufus" or "macropodidae"

wkt

string: WKT (well-known text) defining a polygon within which to limit taxon search, e.g. "POLYGON((140 -37,151 -37,151 -26,140 -26,140 -37))"

fq

string: character string or vector of strings, specifying filters to be applied to the original query. These are of the form "INDEXEDFIELD:VALUE" e.g. "kingdom:Fungi". See ala_fields("occurrence") for all the fields that are queryable. NOTE that fq matches are case-sensitive, but sometimes the entries in the fields are not consistent in terms of case (e.g. kingdom names "Fungi" and "Plantae" but "ANIMALIA"). fq matches are ANDed by default (e.g. c("field1:abc","field2:def") will match records that have field1 value "abc" and field2 value "def"). To obtain OR behaviour, use the form c("field1:abc OR field2:def")

Value

data frame of results, where each row is a taxon, its classification information, and its occurrence count

Author(s)

Atlas of Living Australia support@ala.org.au

References

http://api.ala.org.au/ http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/doc-files/WKT.html

See Also

ala_fields for occurrence fields that are queryable via the fq parameter

Examples

## Not run: 
x=specieslist(taxon="macropus",wkt="POLYGON((145 -37,150 -37,150 -30,145 -30,145 -37))")

x=specieslist(wkt="POLYGON((147.62 -42.83,147.60 -42.86,147.65 -42.87,147.70 -42.86,147.62 -42.83))",fq="rank:species")

## End(Not run)

[Package ALA4R version 1.01 Index]