taxonLookup: Lookup GBIF Taxonomic Information

View source: R/gbifDownload.R

taxonLookupR Documentation

Lookup GBIF Taxonomic Information

Description

A function that iteratively calls the name_lookup function to retrieve information relating to a taxon (or selection of taxa) contained at GBIF.

Usage

taxonLookup(
  kingdom = NULL,
  phylum = NULL,
  class = NULL,
  order = NULL,
  family = NULL,
  genus = NULL,
  species = NULL,
  other = NULL,
  limit = NULL,
  rank = NULL,
  ...
)

Arguments

kingdom

A character vector containing the kingdoms that the taxa retrieved from GBIF's taxonomies database must belong to. An entry with a length greater than one will ensure that all retrieved entries must belong to one of the kingdoms specified in the input. A value of NULL ensures that entries will not be filtered according to any criteria at this taxonomic level.

phylum

A character vector containing the phyla that the taxa retrieved from GBIF's taxonomies database must belong to. An entry with a length greater than one will ensure that all retrieved entries must belong to one of the phyla specified in the input. A value of NULL ensures that entries will not be filtered according to any criteria at this taxonomic level.

class

A character vector containing the classes that the taxa retrieved from GBIF's taxonomies database must belong to. An entry with a length greater than one will ensure that all retrieved entries must belong to one of the classes specified in the input. A value of NULL ensures that entries will not be filtered according to any criteria at this taxonomic level.

order

A character vector containing the orders that the taxa retrieved from GBIF's taxonomies database must belong to. An entry with a length greater than one will ensure that all retrieved entries must belong to one of the orders specified in the input. A value of NULL ensures that entries will not be filtered according to any criteria at this taxonomic level.

family

A character vector containing the families that the taxa retrieved from GBIF's taxonomies database must belong to. An entry with a length greater than one will ensure that all retrieved entries must belong to one of the families specified in the input. A value of NULL ensures that entries will not be filtered according to any criteria at this taxonomic level.

genus

A character vector containing the genera that the taxa retrieved from GBIF's taxonomies database must belong to. An entry with a length greater than one will ensure that all retrieved entries must belong to one of the genera specified in the input. A value of NULL ensures that entries will not be filtered according to any criteria at this taxonomic level.

species

A character vector containing the species that the taxa retrieved from GBIF's taxonomies database must belong to. An entry with a length greater than one will ensure that all retrieved entries must belong to one of the species specified in the input. A value of NULL ensures that entries will not be filtered according to any criteria at this taxonomic level.

other

A character vector containing the values for the taxonomic level specified in the rank argument that the taxa retrieved from GBIF's taxonomies database must belong to. An entry with a length greater than one will ensure that all retrieved entries must belong to one of the values specified in the input. A value of NULL ensures that entries will not be filtered according to any criteria at this taxonomic level.

limit

An integer scalar containing the maximum number of entries to return from the query. A value of NULL indicates that all valid entries will be returned.

rank

If the other parameter is non-NULL then a scalar character must be provided here defining the taxonomic level to conduct the query at. See name_lookup for acceptable values to use for the rank argument.

...

Other parameters passed to the name_lookup function when querying GBIF's taxonomies database.

Value

A data.frame containing the taxonomic information for all matching taxa according to the criteria specified in the function arguments.

Author(s)

Joseph D. Chipperfield, joechip90@googlemail.com

See Also

name_lookup


joechip90/PaGAn documentation built on April 17, 2025, 4:05 p.m.