renderRmd | R Documentation |
Function that renders documents at Rapporteket from rmarkdown source files.
Output formats may be (vanilla) HTML or PDF based on our own pandoc latex
template or fragments of html when the result is to be embedded in existing
web pages. Rmarkdown allow parameters to be part of report processing. Thus,
parameters that are specific to reports must be provided (as a named list)
when calling renderRmd()
.
renderRmd(
sourceFile,
outputType = "html",
logoFile = NULL,
params = list(),
template = "default"
)
sourceFile |
Character string providing the path to the rmarkdown source file. |
outputType |
Character string specifying the output format. Must be one
of |
logoFile |
Character string with path to the logo to be used for PDF
output. Often, this will be the registry logo. Only PNG and PDF graphics are
allowed. Default value is |
params |
List of report parameters (as named values) to override the
corresponding entries under params in the rmarkdown document yaml
header. Default is |
template |
Character string defining which template to use for making pdf documents. Must be one of "default" or "document" where the first is assumed if this argument is not set. |
Character string with path to the rendered file or, if
outputType
is set to "html_fragment", a character string providing an
html fragment. Files are named according to tempfile()
with an empty
pattern and with the extension according to outputType
("pdf" or "html").
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.