writeConfig: Write Configuration File

Description Usage Arguments Details Value See Also Examples

Description

writeConfig writes collapsed list to a tab-delimited file.

Usage

1
writeConfig(file, path = NULL, parameters)

Arguments

file

character string: giving the name of the configuration file to write parameters.

path

character string: giving the directory to write the file.

parameters

list: giving key/value pairs of paramenters for analysis.

Details

writeConfig collapses a list of key/value pairs representing the parameters for the analysis and writes them to a specified tab-delimited file.

writeConfig is used to write configuration files in buildConfig. See importConfig for required and accepted key/value pairs.

writeConfig returns the new configuration file location.

Value

A character string containing the name of the output file.

See Also

Other configuration functions: buildConfig, importConfig, validateConfig

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
## 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
 writeConfig("config.txt", parameters=params)

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

## End(Not run)

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