start_report: Start report

In tarkomatas/myprettyreport: Custom PDF report layouts to export ggplot2 visualizations

Description

This is the first mandatory function to generate the report. It defines some basic parameters.

Usage

start_report(filename = "report_output", title = "Coolest Report Ever",
  subtitle = "Easy & flexible way to create good-looking reports.",
  size = c("a4", "a4r"))

Arguments

filename	Character string giving the name of the output PDF file.
title	Title of the report. Character string which appears both on the cover page and the report page. Default title is "Coolest Report Ever".
subtitle	Subitle of the report. Character string which appears both on the cover page and the report page. Default subtitle is "Easy & flexible way to create good-looking reports.".
size	Character string which specifies the paper size of the output PDF file. Currently implemented values are "a4" and "a4r" (rotated landscape). Default paper size is "a4".

Examples

# minimal example
# it generates a PDF file which does not contains anything
start_report() %>%
  end_report()

# custom filename, title and subtitle on the report page
start_report(
    filename = "mycustom_output",
    title = "My Custom Title",
    subtitle = "My Custom Subtitle"
) %>%
  add_cover_page() %>%
  end_report()

# rotated landscape (a4r)
start_report(size = "a4r") %>%
  add_cover_page() %>%
  end_report()

tarkomatas/myprettyreport documentation built on May 9, 2019, 7:40 a.m.