create_report: Create a html report of a simulation result using rmarkdown

In NErler/simvalidator: Validation of Statistical Models via Simulation

Create a html report of a simulation result using rmarkdown

Description

Create a html report of a simulation result using rmarkdown

Usage

create_report(
  object,
  title = NULL,
  output_file = "simulation_report",
  output_dir = tempdir(),
  ...
)

Arguments

object	simulation_result object
title	not yet used
output_file	The name of the output file. If using NULL then the output filename will be based on filename for the input file. If a filename is provided, a path to the output file can also be provided. Note that the output_dir option allows for specifying the output file path as well, however, if also specifying the path, the directory must exist. If output_file is specified but does not have a file extension, an extension will be automatically added according to the output format. To avoid the automatic file extension, put the output_file value in I(), e.g., I('my-output').
output_dir	The output directory for the rendered output_file. This allows for a choice of an alternate directory to which the output file should be written (the default output directory of that of the input file). If a path is provided with a filename in output_file the directory specified here will take precedence. Please note that any directory path provided will create any necessary directories if they do not exist.
...	additional arguments passed to rmarkdown::render()

NErler/simvalidator documentation built on May 17, 2022, 7:54 a.m.