build_report: Build report from template

In chriszheng2016/zstmodelr: Stock Factor Models for China Stock Market Investment

Description

It's a wrapper of rmarkdown::render() to build report from template by customized arguments.

Usage

build_report(
  report_template,
  report_params = NULL,
  output_format = NULL,
  output_sn = NULL,
  output_dir = "output",
  quiet = TRUE,
  encoding = "UTF-8",
  ...
)

Arguments

report_template	A rmd file as report template. See input argument of rmarkdown::render() for details.
report_params	A list of report params, by default NULL. See params argument of rmarkdown::render() for details.
output_format	The R Markdown output format to convert to. See output_format argument of rmarkdown::render() for details.
output_sn	Serial number or id for output file. Default NULL
output_dir	Path of dir to save output file. Default "output" means to save file in output in current dir. If NULL save in directory of template file, otherwise in output_dir.
quiet	A logic flag of whether to suppress printing of the pandoc command line.
encoding	Ignored. The encoding is always assumed to be UTF-8.
...	Arguments passed to rmarkdown::render().

Value

No return.

chriszheng2016/zstmodelr documentation built on June 13, 2021, 8:59 p.m.