knit_report: Custom Knit function for RStudio to build report

Description Usage Arguments

View source: R/utils-report.R

Description

A wrapper of build_report() as a custom knit function for Knit button in RStudio.

Usage

1
2
3
4
5
6
7
8
knit_report(
  input,
  report_params = "ask",
  output_format = NULL,
  output_sn = Sys.Date(),
  output_dir = "output",
  ...
)

Arguments

input

The input file to be rendered as as report template, which is required by customized knit function.

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.

...

Arguments passed to rmarkdown::render().


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