chronicle (version 0.2.1)

output_config: Wrapper to update chronicle from github

Description

Quality of life improvement until I submit the package to CRAN. Runs devtools::install_github('pheymanss/chronicle') Build the yaml output specification for an R Markdown

Usage

output_config(
  output_format,
  number_sections = FALSE,
  table_of_content = FALSE,
  table_of_content_depth = 1,
  fig_width = 11,
  fig_height = 5,
  prettydoc_theme = "leonids"
)

Arguments

output_format

The format of the R Markdown file.

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.

prettydoc_theme

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

Value

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

Details

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

Examples

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