occ_options: Look up options for parameters passed to each source

Description Usage Arguments Details Value Examples

View source: R/occ_options.r

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, idigibio and/or vertnet. 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. rgbif::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., 'rv' for 'rvertnet').

For some data sources we don't import the canonical package, but instead have our own intenral helper functions and the package in question is not imported, but we do suggest seeing the help for the package on their parameters:

  • AntWeb: ?AntWeb::aw_data

  • ecoengine: ?ecoengine::ee_observations

For others,

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
## 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('ebird')
occ_options('bison')
occ_options('idigbio')
occ_options('vertnet')

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

## End(Not run)

spocc documentation built on May 19, 2017, 11:25 p.m.

Search within the spocc package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.