Basic YAML

yml() yml_empty()

Create a new yml object

yml_author() yml_date() yml_title() yml_subtitle() yml_abstract() yml_keywords() yml_subject() yml_description() yml_category() yml_lang() yml_toplevel()

Set Top-level R Markdown YAML Fields

yml_output()

Capture, validate, and write output YAML

yml_latex_opts()

Set LaTeX YAML options for PDF output

yml_runtime()

Activate Shiny in R Markdown

yml_clean()

Remove intermediate rendering files

yml_resource_files()

Add external resource files to R Markdown document

includes2()

Include content within output

yml_toc()

Specify Table of Contents options

Parameterized R Markdown Reports

yml_params() shiny_params() shiny_checkbox() shiny_numeric() shiny_slider() shiny_date() shiny_text() shiny_file() shiny_radio() shiny_select() shiny_password()

Parameterize an R Markdown report using Shiny components

Websites

yml_site_opts() yml_navbar() navbar_page() navbar_separator()

Add site options for _site.yml and navbars for R Markdown websites

yml_vignette()

Set up a package vignette

References and Citations

bib2yml()

Convert bib files to YAML

yml_citations()

Set citation-related YAML options

yml_reference() reference()

Write references as YAML fields

Working with YAML

as_yml()

Convert to yml object

yml_load()

Load YAML from string

draw_yml_tree()

Draw an tree of YAML hierarchy

is_yml()

Is object a yml object?

has_field()

Check if field exists in YAML

last_yml()

Return the most recently printed YAML

yml_blank() is_yml_blank()

Return a blank object to be discarded from YAML

yml_code() yml_params_code()

Take code and write it as valid YAML

yml_handlers()

Set handlers to process the way YAML is printed

yml_replace() yml_discard() yml_pluck() yml_chuck()

Replace, pluck, or discard top-level YAML fields

yml_verbatim()

Write YAML field or content verbatim

asis_yaml_output()

Export yml object as a YAML knitr code chunk

Writing to YAML and R Markdown files

pandoc_template_types() pandoc_highlight_styles() use_pandoc_template() use_pandoc_highlight_style()

Use pandoc templates and custom highlight themes

use_yml_file() use_output_yml() use_site_yml() use_navbar_yml() use_pkgdown_yml() use_bookdown_yml()

Write YAML to file

use_yml() use_rmarkdown() use_index_rmd()

Copy YAML code to your clipboard or write to a new R Markdown file

code_chunk() setup_chunk()

Write code chunks programmatically

use_yml_defaults() use_rmd_defaults() get_yml_defaults() get_rmd_defaults()

Set up default YAML

read_json() read_toml() write_as_json() write_as_toml()

Read and write to JSON and TOML

R Markdown Extensions

yml_blogdown_opts()

Set Top-level YAML options for blogdown

blogdown_template() blogdown_archetypes()

Create YAML based on blogdown theme archetypes

yml_bookdown_opts() yml_bookdown_site()

Set Top-level YAML options for bookdown

gitbook_config()

Configure bookdown::gitbook() output

yml_distill_opts() yml_distill_author() distill_listing() distill_collection() distill_resources()

Set Top-level YAML options for distill

yml_pagedown_opts()

Top-level YAML options for pagedown

pagedown_business_card_template() pagedown_person()

Generate a full YAML template for your pagedown business card

yml_pkgdown() yml_pkgdown_opts() yml_pkgdown_development() yml_pkgdown_template() yml_pkgdown_reference() pkgdown_ref() yml_pkgdown_news() yml_pkgdown_articles() pkgdown_article() yml_pkgdown_tutorial() pkgdown_tutorial() yml_pkgdown_figures() yml_pkgdown_docsearch()

Set Top-level YAML options for pkgdown

pkgdown_template()

Generate a full YAML template for your pkgdown site

yml_rsconnect_email() yml_output_metadata()

Set YAML for Scheduled Emails in RStudio Connect

yml_rticles_opts() rticles_author() rticles_address() rticles_corr_author()

Set YAML related to rticles output formats