spocc (version 0.6.0)

occ_names_options: Look up options for parameters passed to each source for occ_names function

Description

Look up options for parameters passed to each source for occ_names function

Usage

occ_names_options(from = "gbif", where = "console")

Arguments

from

(character) Data source to get data from, any combination of gbif, bison, and/or ecoengine. Case doesn't matter.

where

(character) One of console (print to console) or html (opens help page, if in non-interactive R session, prints help to console).

Value

Opens up the documentation for the function that is used internally within the occ function for each source.

Details

Any of the parameters passed to e.g. name_lookup from the rgbif package can be passed in the associated gbifopts list in occ.

Note that the from parameter is lowercased within the function and is called through match.arg first, so you can match on unique partial strings too (e.g., 'e' for 'ecoengine').

Examples

## Not run: 
# # opens up documentation for this function
# occ_names_options()
# 
# # Open up documentation for the appropriate search function for each source
# occ_names_options('gbif')
# occ_names_options('ecoengine')
# occ_names_options('bison')
# 
# # Or open in html version
# occ_names_options('bison', 'html')
# ## End(Not run)