syberia_config: Fetch the configuration for a Syberia project.

Description Usage Arguments Value

View source: R/config.r

Description

Fetch the configuration for a Syberia project.

Usage

1
syberia_config(root = syberia_root(), exists_check = FALSE)

Arguments

root

character. The root of the Syberia project. The default is syberia_root().

exists_check

logical. If TRUE, it will only return whether or not the directory contains a syberia configuration file (either syberia.config or syberia_config.r, with the extensions case-insensensitive, .r or .R). The default is FALSE: The whole syberia configuration will be returned for this project as a list.

Value

the syberia configuration. All local variables set in the syberia configuration file will be part of a list of options for this project. TODO: (RK) Record list of possible options somewhere.


robertzk/syberiaStructure documentation built on May 27, 2019, 11:38 a.m.