Description

Render an rmarkdown notebook. Supports parametrization.

Input

name:type
description
pattern

meta

:map

Groovy Map containing sample information e.g. [ id:‘test’, single_end:false ]

notebook

:file

Rmarkdown file

*.{Rmd}

parameters

:map

Groovy map with notebook parameters which will be passed to rmarkdown to generate parametrized reports.

input_files

:file

One or multiple files serving as input data for the notebook.

*

Output

name:type
description
pattern

report

meta

:map

Groovy Map containing sample information e.g. [ id:‘test’, single_end:false ]

*.html

:file

HTML report generated from Rmarkdown

*.html

parameterised_notebook

meta

:map

Groovy Map containing sample information e.g. [ id:‘test’, single_end:false ]

*.parameterised.Rmd

:file

Parameterised Rmarkdown file

*.parameterised.Rmd

artifacts

meta

:map

Groovy Map containing sample information e.g. [ id:‘test’, single_end:false ]

artifacts/*

:file

Artifacts generated by the notebook

artifacts/*

session_info

meta

:map

Groovy Map containing sample information e.g. [ id:‘test’, single_end:false ]

session_info.log

:file

dump of R SessionInfo

*.log

versions_rmarkdownnotebook

${task.process}

:string

The process the versions were collected from

rmarkdownnotebook

:string

Name of the tool

Rscript -e "cat(paste(packageVersion('rmarkdown'), collapse='.'))"

:eval

The expression to obtain the version of the tool

Topics

name:type
description
pattern

versions

${task.process}

:string

The process the versions were collected from

rmarkdownnotebook

:string

Name of the tool

Rscript -e "cat(paste(packageVersion('rmarkdown'), collapse='.'))"

:eval

The expression to obtain the version of the tool