getTVKQuery: Gets TVKs for a query

In ropensci/rnbn: Access NBN Data

Gets TVKs for a query

Description

Given a search term this function returns taxon information, including pTVKs, for the first 25 taxa that match that search on the NBN.

Usage

getTVKQuery(query = NULL, species_only = TRUE, rec_only = FALSE,
  top = FALSE, ...)

Arguments

query	A query string. This can range from latin binomials to partial english names.
species_only	Logical, if TRUE pTVKs of species are returned (i.e. sub-species and aggregates are removed). Defaults to TRUE
rec_only	Logical, if TRUE pTVKs of recommended names are returned (i.e. synonyms are removed). Defaults to FALSE. Remember, the pTVK of a synonym is a taxa with 'recommended' name status.
top	Logical, if TRUE only the top answer is returned. This is what the gateway thinks you are most likely to be after but may not always be right, use with care!
...	Further named parameters passed on to GET

Value

A dataframe containing information on each taxa entry that matches the query string in rows. ptaxonVersionKey (preferred taxon version key) should be used when searching for records.

Author(s)

Tom August, CEH [e-mail]

See Also

getGroupSpeciesTVKs, getOccurrences

Examples

## Not run:  
 t <- getTVKQuery('blue tit')

## End(Not run)

ropensci/rnbn documentation built on May 18, 2022, 6:42 p.m.