renderFile {clinDataReview}R Documentation

Render a rmarkdown file, possibly in a new R session

Description

This has the possibility to save output in a log file, and saving also session information.

Usage

renderFile(input, encoding = "UTF-8", params = NULL, logFile = NULL, ...)

Arguments

input

Input file to be rendered.

encoding

String with encoding, 'UTF-8' by default.

params

List with input parameters for this document.
These parameters should be accessed in the Rmd document via params$....
These parameters will be saved to a RDS file and imported during the report rendering.

logFile

(optional) String with path to a log file, where output (also error/messages/warnings) should be stored. If specified, the entire output is re-directed to this file.

...

Any extra parameters passed to render, for expert use only.

Details

Note: this function is inspired from xfun::Rscript_call

Value

Output of the function with additional attribute: 'sessionInfo' containing the details of the session information. If the report fails, an error message is returned.

Author(s)

Laure Cougnaud


[Package clinDataReview version 1.5.0 Index]