parameterDump: Save Parameters in a Text File

Description Usage Arguments Details Value Note Author(s) See Also Examples

View source: R/param.r

Description

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

Usage

1
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 [email protected]

See Also

See vignettes: browseVignettes("ramwas")

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
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") )

ramwas documentation built on Nov. 29, 2019, 2 a.m.