sbdi_config: Get or set configuration options that control SBDI4R...

In biodiversitydata-se/SBDI4R: Swedish Biodiversity Data Infrastructure Data and Resources in R

Get or set configuration options that control SBDI4R behaviour

Description

Get or set configuration options that control SBDI4R behaviour

List valid download reasons

Usage

sbdi_config(...)

ala_config(...)

sbdi_reasons()

Arguments

...

Options can be defined using name=value. Valid options are: reset: sbdi_config("reset") will reset the options to their default values caching string: caching can be "on" (results will be cached, and any cached results will be re-used), "refresh" (cached results will be refreshed and the new results stored in the cache), or "off" (no caching, default). cache_directory string: the directory to use for the cache. By default this is a temporary directory, which means that results will only be cached within an R session and cleared automatically when the user exits R. The user may wish to set this to a non-temporary directory for caching across sessions. The directory must exist on the file system. verbose logical: should sbdi4R give verbose output to assist debugging? (default=FALSE) warn_on_empty logical: should a warning be issued if a request returns an empty result set? (default=FALSE) user_agent string: the user-agent string used with all web requests to the sbdi servers. Default = "sbdi4R" with version number text_encoding string: text encoding assumed when reading cached files from local disk (default="UTF-8") download_reason_id numeric or string: the "download reason" required by some sbdi services, either as a numeric ID (currently 0–11) or a string (see sbdi_reasons() for a list of valid ID codes and names). By default this is NA. Some sbdi services require a valid download_reason_id code, either specified here or directly to the associated R function.

Value

For sbdi_config(), a list of all options. When sbdi_config(...) is called with arguments, nothing is returned but the configuration is set.

References

https://api.biodiversitydata.se/

https://spatial.biodiversitydata.se/layers/ this will eventually move to the api link

Invoking sbdi_config() with no arguments returns a list with the current values of the options.

sbdi_reasons() returns a data frame with information describing the valid options for download_reason_id

Examples

## Not run: 
 sbdi_config()
 sbdi_config(caching="off")
 sbdi_config()
 sbdi_config(download_reason_id=0,verbose=TRUE)
 sbdi_config("reset")

## End(Not run)

biodiversitydata-se/SBDI4R documentation built on Feb. 23, 2024, 4:15 p.m.