cache_RDS: Cache dataset(s) from a ProxyDataManager to RDS

In paleovar/ptboxproxydata: The Proxy Data Manager for a consistent, efficient and reusable data workflow for (paleo) time series within the PaleoToolBox (PTBox)

Cache dataset(s) from a ProxyDataManager to RDS

Description

Cache dataset(s) from a ProxyDataManager to RDS

Usage

cache_RDS(x, ...)

Arguments

mng	ProxyDataManager
dataset_names	character, single or vector of datasets to load or 'all' to cache all available datasets.
output_format	character, one of c('Proxytibble', 'tibble'). 'tibble' corresponds to 'tibble::tibble'
zoo_format	character, one of c('zoo', 'zoo_STACY'). format of the proxy data. See Details and ‘vignette(’zoo-support-sdm')'.
RDS_root	character, root directory for pre-formatted .RDS data. See Details for more.
force_file	logical, if TRUE forces to load all 'dataset_names' from file and to recreate the corresponding RDS caches.

Value

dataset(s) in specified format

Details

Datasets are always cached to RDS and meta data entries are written if they are loaded for the first time. This can be triggered when supplying the respective 'dataset_names' to load_set or to cache_RDS.

If directory specified as RDS_root does not exist, will try to create it simply (i.e. non-recursively). Throws an error if RDS_root cannot be created in this way. In this case check the path you submitted and potentially create the necessary directories. This functionality is kept rudimentary by intention to avoid filling storage spaces unintentionally.

zoo_format is ignored if output_format == 'tibble' because proxy data as 'zoo::zoo'/'PTBoxProxydata::zoo_STACY' objects is only supported by 'PTBox' inside the 'PTBoxProxydata::Proxytibble' conventions.

paleovar/ptboxproxydata documentation built on June 1, 2022, 1:12 a.m.