read.yaml.config: Read YAML config

Description Usage Arguments Details Value See Also Examples

Description

Read and validate the configuration associated with a microarray experiment.

Usage

1
read.yaml.config(config, checkGroups = TRUE, getGroups = TRUE)

Arguments

config

Character string consisting of the path to the configuration file generated using the write.yaml.config function or parsed configuration list associated with a microarray experiment.

checkGroups

logical indicating whether the group file must exist when doing the validation.

getGroups

logical indicating whether the data in the group file must also be validated and returned in the configuration.

Details

Each configuration option is checked for incongruities, including whether or not it is missing, its type, and its value.

Value

A list of the configuration options. If the configuration has been fully validated including the group file, the class of the resulting configuration becomes MadeConfig.

See Also

write.yaml.config to generate the configuration file and read.group.file to read and validate the group file.

Examples

1
2
3
4
5
6
7
if(require(madeData))
{
  config <- system.file("extdata", "config.yaml", package = "madeData")
  read.yaml.config(config)
}
read.yaml.config(config, checkGroups = FALSE, getGroups = FALSE)
read.yaml.config("config.yaml")

fboulnois/made documentation built on May 16, 2019, 12:01 p.m.