search_names {ALA4R}R Documentation

Lookup of taxonomic names

Description

Provides GUID, taxonomic classification, and other information for a list of names. Case-insensitive but otherwise exact matches are used.

Usage

search_names(taxa = c(), vernacular = FALSE, guids_only = FALSE,
  output_format = "simple")

Arguments

taxa

string: a single name or vector of names

vernacular

logical: if TRUE, match on common names as well as scientific names, otherwise match only on scientific names

guids_only

logical: if TRUE, a named list of GUIDs will be returned. Otherwise, a data frame with more comprehensive information for each name will be returned.

output_format

string: controls the print method for the returned object (only applicable when guids_only is FALSE). Either "complete" (the complete data structure is displayed), or "simple" (a simplified version is displayed). Note that the complete data structure exists in both cases: this option only controls what is displayed when the object is printed to the console. The default output format is "simple"

Value

A data frame of results, or named list of GUIDs if guids_only is TRUE

Author(s)

Atlas of Living Australia support@ala.org.au

References

http://api.ala.org.au/

Examples

s1=search_names(c("Grevillea humilis","Grevillea humilis subsp. maritima","Macropus","Thisisnot aname"))
str(s1)
s2=search_names(c("Grevillea humilis","Grevillea humilis subsp. maritima","Macropus","Thisisnot aname"),guids_only=TRUE)
str(s2)
ss=search_names("Grevillea",vernacular=FALSE) ## should return the genus Grevillea
str(ss)
sv=search_names("Grevillea",vernacular=TRUE) ## should return the species Grevillea banksii, because it has the common name ``Grevillea"
str(sv) ## see the complete data structure

[Package ALA4R version 1.01 Index]