sits (version 0.10.0)

sits_config: Reads a configuration file and loads it in the main environment

Description

Reads a user-specified configuration file, located in a "config.yml" file in the working directory. If this file is not found, reads a default package configuration file. By default, the sits configuration file "config.yml" is located at the directory "extdata" of the package.

The user can provide her additional configuration on an additional configuration file, which is located by default on ~/.sits/config.yml.

To see the contents of the configuration file, please use sits_config_show.

Usage

sits_config()

Value

A list with the configuration parameters used by sits.

Examples

# NOT RUN {
# create configuration file
config_sits <- sits_config()
# show configuration file
sits_config_show()
# }