sal2rmd: Translate SYSargsList back to a workflow template Rmarkdown...

Description Usage Arguments Value Author(s) Examples

View source: R/sal2_utilities.R

Description

This function takes a SYSargsList object and translate it to SPR workflow template Rmarkdown format.

Usage

1
2
3
4
5
sal2rmd(sal, out_path = "spr_template.Rmd", rmd_title = "SPR workflow template", 
        rmd_author = "my name", 
        rmd_date = "Last update: `r format(Sys.time(), '%d %B, %Y')`", 
        rmd_output = "html_document", 
        desc = "This is a workflow template.", verbose = TRUE)

Arguments

sal

SYSargsList object.

out_path

string, output file name.

rmd_title

string, title of the Rmd

rmd_author

string, author(s) of the Rmd, put all authors in a single character string

rmd_date

string, date header of Rmd

rmd_output

string, output format of Rmd, used in header

desc

string, or character vector of strings, some description text in format Rmarkdown that will be added to the document before the workflow steps start. It can be a single line or multiple lines by providing a character vector, each item is one line.

verbose

bool, open verbose mode? This will show you more information as the function runs

Value

no return

Author(s)

Le Zhang and Daniela Cassol

Examples

1
2
3
4
file_path <- system.file("extdata/spr_simple_wf.Rmd", package="systemPipeR")
sal <- SPRproject(overwrite = TRUE)
sal <- importWF(sal, file_path)
sal2rmd(sal)

tgirke/systemPipeR documentation built on Oct. 20, 2021, 10:04 a.m.