R: Save Parameters in a Text File

parameterDump {ramwas}

R Documentation

Save Parameters in a Text File

Description

Saves parameters in a text file, prioritizing those listed in toplines.

Usage

parameterDump(dir, param, toplines = NULL)

Arguments

`dir`	Directory to save the parameters to. The file is named `"UsedSettings.txt"`.
`param`	A list with RaMWAS parameters. Or any list in general. For detailed description of all available parameters run: `browseVignettes("ramwas")`.
`toplines`	Names of the elements in `param` to save first (top of the file).

Details

This function is used internally by multiple RaMWAS functions to record parameters used to run the analysis.

Value

The function creates a file and returns nothing.

Note

This function is not intended to be run by the user.

Author(s)

Andrey A Shabalin andrey.shabalin@gmail.com

Examples

param = ramwasParameters(
    number = 123123,
    integer = 312L,
    textline = "Hi there",
    characterVector = c("Hi","Hi again","Bye"),
    dataframe = data.frame(a = 1:12, b = 12:1)
    )

thedir = tempdir()

parameterDump(thedir, param, c("integer","characterVector"))

cat( readLines( paste0(thedir,"/UsedSettings.txt") ), sep = "\n")

file.remove( paste0(thedir,"/UsedSettings.txt") )

[Package ramwas version 1.6.0 Index]