Generate report on Revision Analysis
Usage
render_report(
rslt,
output_file,
output_dir,
output_format = c("html_document", "pdf_document"),
open_report = TRUE,
...
)Arguments
- rslt
an object of class `"rjd3rev_vintages"` which is the output of the function `revision_analysis()`
- output_file
path or name of the output file containing the report
- output_dir
path of the dir containing the output file (Optional)
- output_format
either an HTML document (default) or a PDF document
- open_report
Boolean. Default is TRUE meaning that the report will open automatically after being generated.
- ...
Arguments to be passed to `rmarkdown::render()`, for example: * `output_options` List of output options that can override the options specified in metadata * `...`
Examples
## Simulated data
long_format <- rjd3revisions:::simulate_long(
start_period = as.Date("2020-01-01"),
n_period = 24,
n_revision = 6,
periodicity = 12L
)
## Make analysis and generate the report
vintages <- create_vintages(long_format, periodicity = 12L)
rslt <- revision_analysis(vintages, view = "diagonal")
if (FALSE) {
render_report(
rslt,
output_file = "my_report",
output_dir = "C:/Users/xxx",
output_format = "pdf_document"
)
}