rbison (version 1.0.0)

bison_tax: Search for and collect taxonomic name data from the USGS Bison API using solr

Description

See the SOLR documentation here http://lucene.apache.org/solr/ for other parameters you can use.

The following two methods are possible, as far as I know you can only use one at a time:

• vernacularName The species specific common names that is searchable in a case insensitive way.

• scientificName The species scientific name that is associated with a common name that is searchable in a case insensitive way.

Usage

bison_tax(
  query,
  method = "vernacularName",
  exact = FALSE,
  parsed = TRUE,
  callopts = list(),
  ...
)

Arguments

query

Name to search for. Required.

method

The field to query by. See description below for details.

exact

Exact matching or not. See examples. Defaults to FALSE.

parsed

If TRUE (default) creates data.frame of names data output. Otherwise, a list.

callopts

Further args passed on to crul::HttpClient() for HTTP debugging/inspecting. In bison, bison_providers, and bison_stats, ... is used instead of callopts, but ... is used here to pass additional Solr params.

...

Further solr arguments passed in to the query. See examples below.

Value

A list.

See Also

bison_solr(), bison()

Examples

# NOT RUN {
# All taxa
bison_tax("*:*")

# Some example calls
bison_tax(query="*bear")
bison_tax(query="Helianthus", method="scientificName")

# Exact argument, here nothing found with latter call as '*bear' 
# doesn't exist, which makes sense
bison_tax(query="*bear", exact=FALSE)
bison_tax(query="*bear", exact=TRUE)

# Using solr arguments (not all Solr arguments work)
## Return a certain number of rows
bison_tax(query="*bear", method="vernacularName", rows=3)
## Return certain fields
bison_tax(query="*bear", method="vernacularName", fl='vernacularName')

# Curl options
bison_tax(query='*dolphin', callopts=list(verbose = TRUE))
# }