buildConfig: Build Configuration File

In sanger-pathogens/deago: DEAGO: RNASeq differential expression analysis and GO term enrichment reporter

Description

buildConfig writes a list of validated key/value pairs to a tab-delimited file.

Usage

buildConfig(file, path = NULL, parameters)

Arguments

file	A character string giving the name of the file.
path	A character string giving the directory containing the file. This may be omitted if the file is in the current working directory.
parameters	A list containing key/value pairs which define the parameters for the analysis.

Details

buildConfig takes a list of key/value pairs which represent the parameters for the analysis, validates them using validateConfig and then writes them to a tab-delimited configuration file using writeConfig.

See importConfig for required and accepted key/value pairs.

buildConfig returns the new configuration file location.

Value

A character string containing the name of the output configuration file.

See Also

Other configuration functions: importConfig, validateConfig, writeConfig

Examples

## Not run: 
 # Basic parameter list
 params <- list ( 'counts_directory' = "/path/to/counts.txt",
                  'targets_file'     = "/path/to/targets.txt",
                  'results_directory' = "/path/to/result_dir")

 # Write tab-delimited config file to working directory
 buildConfig("config.txt", parameters=params)

 # Write tab-delimited config file to another directory
 buildConfig("config.txt", path="/path/to/config", parameters=params)

## End(Not run)

sanger-pathogens/deago documentation built on May 28, 2019, 8:42 a.m.