chronicle (version 0.2.1)

new_report: Create the initial Rmarkdown header for a report

Description

Create the initial Rmarkdown header for a report

Usage

new_report(
  title = "New chronicle Report",
  author = "chronicle user",
  prettydoc = TRUE,
  prettydoc_theme = "leonids",
  highlight = "github",
  number_sections = FALSE,
  table_of_content = FALSE,
  table_of_content_depth = 1,
  fig_width = 11,
  fig_height = 5
)

Arguments

title

Title of the report.

author

Author of the report.

prettydoc

Whether or not to use prettydoc formatting on the html report. Default is TRUE.

prettydoc_theme

Name of the theme used on prettydoc. Default is leonids.

highlight

Rmarkdown highlight theming. Default is github highlighting.

number_sections

Whether or not to number the sections and subsections fo the report.

table_of_content

Whether or not to include a table fo content at the beginning of the report.

table_of_content_depth

The depth of sections and subsections to be displayed on the table of content.

fig_width

Set the global figure width or the rmarkdown file.

fig_height

Set the global figure height or the rmarkdown file.

Value

A string containing an R Markdown header

Examples

# NOT RUN {
library(magrittr)
library(chronicle)
new_report(title = 'Simple Report Header',
           author = 'Anonymous Developer',
           prettydoc = FALSE)
new_report(title = 'Prettier Report Header',
           author = 'The same person as before',
           prettydoc = TRUE)
# }