downloadSource: downloadSource

Description Usage Arguments Note Author(s) See Also Examples

View source: R/downloadSource.R

Description

Download a source. The function is a wrapper for specific functions designed for the different possible source types.

Usage

1
downloadSource(type, subtype = NULL, overwrite = FALSE)

Arguments

type

source type, e.g. "IEA". A list of all available source types can be retrieved with function getSources("download").

subtype

For some sources there are subtypes of the source, for these source the subtype can be specified with this argument. If a source does not have subtypes, subtypes should not be set.

overwrite

Boolean deciding whether existing data should be overwritten or not.

Note

The underlying download-functions are required to provide a list of information back to downloadSource. Following list entries should be provided:

This user-provided data is enriched by automatically derived metadata:

Besides the names above (user-provided and automatically derived) it is possible to add custom metadata entries by extending the return list with additional, named entries.

Author(s)

Jan Philipp Dietrich, David Klein

See Also

setConfig, readSource

Examples

1
2
3
4
## Not run:  
a <- downloadSource("Tau", subtype="historical")

## End(Not run)

madrat documentation built on Oct. 11, 2021, 9:10 a.m.