Look up options for parameters passed to each source

Share:

Description

Look up options for parameters passed to each source

Usage

1
occ_options(from = "gbif", where = "console")

Arguments

from

(character) Data source to get data from, any combination of gbif, bison, ebird, AntWeb, idigibio and/or ecoengine. Case doesn't matter. inat is not included here, see that package's help docs.

where

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

Details

Any of the parameters passed to e.g. occ_data 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').

Value

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

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
## Not run: 
# opens up documentation for this function
occ_options()

# Open up documentation for the appropriate search function for each source
occ_options('gbif')
occ_options('ecoengine')
occ_options('AntWeb')
occ_options('antweb')
occ_options('ebird')
occ_options('bison')
occ_options('idigbio')
occ_options('vertnet')

# Or open in html version
occ_options('bison', 'html')

## End(Not run)

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.