chronicle (version 0.3)

output_config: Build the yaml output specification for an R Markdown

Description

Currently supported: prettydoc, ioslides, tufte, flexdashboard, slidy_presentation, html_document, html_notebook.

Usage

output_config(
  output_format,
  title = NULL,
  author = NULL,
  include_date = TRUE,
  number_sections = FALSE,
  table_of_content = FALSE,
  table_of_content_depth = 1,
  fig_width = 8,
  fig_height = 5,
  plot_palette = NULL,
  plot_palette_generator = "plasma",
  rmdformats_theme = "downcute",
  prettydoc_theme = "leonids",
  docx_reference_file = NULL,
  pptx_reference_file = NULL,
  html_theme = "simplex",
  rticles_template = "arxiv_article",
  custom_output = NULL
)

Arguments

output_format

The format of the R Markdown file.

title

Title of the report. If NULL (default), no title will be added.

author

Author of the report. If NULL (default), no author will be added.

include_date

Whether or not to include the date as part of the header. Default is TRUE.

number_sections

Whether or not to number the sections and subsections of 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.

plot_palette

Character vector of hex codes to use on plots.

plot_palette_generator

Palette from the viridis package used in case plot_palette is unspecified or insufficient for the number of colors required. Default value is 'plasma', and possible values are 'viridis', 'inferno', 'magma', 'plasma', 'cividis'.

rmdformats_theme

The theme to be used for [rmdformats](https://github.com/juba/rmdformats) outputs. Default is "downcute", and possible values are "downcute", "robobook", "material", "readthedown", "html_clean", "html_docco".

prettydoc_theme

Name of the theme used on [prettydoc](https://prettydoc.statr.me/themes.html). Default is "leonids", and ossible values are "cayman", "tactile", "architect", "leonids", "hpstr".

docx_reference_file

The path for a blank Microsoft Word document to use as template for the 'word_document' output.

pptx_reference_file

The path for a blank Microsoft PowerPoint document to use as template for the 'powerpoint_presentation' output.

html_theme

The theme to be used for [hmtl_document](https://www.datadreaming.org/post/r-markdown-theme-gallery/) outputs. Default is "simplex".

rticles_template

The theme to be used fo [rticles](https://github.com/rstudio/rticles). Default is "arxiv_article"

custom_output

[Experimental] This is to get output formats not currently supported. It should be a YAML element with the corresponding output

Value

The lines needed in the yaml header of an R Markdown file to render as the specified output type.

Examples

# NOT RUN {
cat(output_config('prettydoc'))
cat(output_config('ioslides'))
# }