chronicle (version 0.1.0)

render_report: Render the report using current environment

Description

Render the report using current environment

Usage

render_report(
  report,
  filename = "Chronicle report",
  directory = getwd(),
  keep_rmd = FALSE,
  render_html = TRUE,
  render_pdf = FALSE
)

Arguments

report

The caracter string created by chronicle functions

filename

The name of the .html created

directory

The directory in which to render the .html report

keep_rmd

Whether or not to keep the .Rmd file. Default is false.

render_html

Whether or not to render the report as an interactive hmtl file.

render_pdf

Whether or not to render the report as a PDF file. Keep in mind that while the file will be much more lightweight, you will lose all the interactivity the html provides.

Value

Renders the report as an HTML file.

Examples

# NOT RUN {
library(chronicle)
library(magrittr)
new_report() %>% render_report(filename = 'test_report')
file.remove('test_report.html')
# }