powoGenera: Extract list of genera for any plant family

In DBOSlab/expowo: An R package for mining global plant diversity and distribution data

Extract list of genera for any plant family

Description

Produces a CSV file listing all genera with associated number of accepted species and geographical distribution for any vascular plant family at Plants of the World Online (POWO).

Usage

powoGenera(family,
           genus = NULL,
           hybrid = FALSE,
           country = NULL,
           verbose = TRUE,
           rerun = FALSE,
           save = FALSE,
           dir = "results_powoGenera",
           filename = "output")

Arguments

family	Either one family name or a vector of multiple families that is present in POWO.
genus	Either one genus name or a vector of multiple genera that is present in POWO. If any genus name is not provided, then the function will search all accepted genera known for the target family.
hybrid	Logical, if TRUE, the search results will include hybrid genera.
country	Either one country name or a vector of multiple countries. If country names are provided, then the function will return only the genera that are native to such countries, according to POWO.
verbose	Logical, if FALSE, a message showing each step during the POWO search will not be printed in the console in full.
rerun	Logical, if TRUE, a previously stopped search will continue from where it left off, starting with the last retrieved taxon. Please ensure that the 'filename' argument exactly matches the name of the CSV file saved from the previous search, and that the previously saved CSV file is located within a subfolder named after the current date. If it is not, please rename the date subfolder accordingly."
save	Logical, if TRUE, the search results will be saved on disk.
dir	Pathway to the computer's directory, where the file will be saved provided that the argument save is set up in TRUE. The default is to create a directory named results_powoGenera and the search results will be saved within a subfolder named after the current date.
filename	Name of the output file to be saved. The default is to create a file entitled output.

Value

A table with the following fields: family, genus, authors, scientific_name, publication (information about the protologue of the genus), species_number, native_to_country (original distribution according to political country), native_to_botanical_countries (original distribution according to botanical country), introduced_to_country (exotic distribution according to political country), introduced_to_botanical_countries (exotic distribution according to botanical country), kew_id (genus code within Kew's databases), powo_uri (URI to access each genus in POWO).

Author(s)

Debora Zuanny & Domingos Cardoso

See Also

megaGen

topGen

powoSpecies

powoFam

POWOcodes

Examples

## Not run: 
library(expowo)

powoGenera(family = "Lecythidaceae",
           verbose = TRUE,
           save = FALSE,
           dir = "results_powoGenera",
           filename = "Lecythidaceae_genera")

powoGenera(family = "Lecythidaceae",
           genus = "Bertholletia",
           country = c("Argentina", "Brazil", "French Guiana"),
           verbose = TRUE,
           save = FALSE,
           dir = "results_powoGenera",
           filename = "Lecythidaceae_search")

## End(Not run)

DBOSlab/expowo documentation built on Oct. 29, 2024, 6:27 p.m.