beginPipelineRun: This function is for an older version of MethylPipeR and is...

View source: R/pipeline_modules.R

beginPipelineRunR Documentation

This function is for an older version of MethylPipeR and is now deprecated. It is currently still included to allow old scripts to run correctly. To be called at the beginning of a pipeline run.

Description

This function is for an older version of MethylPipeR and is now deprecated. It is currently still included to allow old scripts to run correctly. To be called at the beginning of a pipeline run.

Usage

beginPipelineRun(note, randomSeed = 42, log = TRUE, logFolderPath)

Arguments

note

A string describing the pipeline run. This will be saved in the pipeline run log.

randomSeed

A number to be used as the random seed in pipeline function calls.

log

TRUE iff the pipeline log should be saved to file.

logFolderPath

if log is TRUE, the log file will be saved in the folder specified by logFolderPath.

Value

A list containing pipeline run information. Many of the pipeline functions require this list to be passed in as an argument.


marioni-group/MethylPipeR documentation built on Oct. 10, 2024, 3:32 p.m.