use_yml_defaults: Set up default YAML

View source: R/use_yml.R

use_yml_defaultsR Documentation

Set up default YAML

Description

use_yml_defaults() takes a yml object and places code on the clipboard that will save the resulting YAML as the default for yml(). The code that is placed on the clipboard is raw YAML passed to ymlthis.default_yml via options(). Saving this code to your .Rprofile (see usethis::edit_r_profile())) will allow yml() or get_yml_defaults() to return the saved YAML. use_rmd_defaults() does the same for ymlthis.rmd_body, which is used in use_rmarkdown() as the body text of the created R Markdown file.

Usage

use_yml_defaults(.yml)

use_rmd_defaults(x)

get_yml_defaults()

get_rmd_defaults()

Arguments

.yml

a yml object created by yml(), as_yml(), or returned by a yml_*() function

x

a character vector to use as the body text in use_rmarkdown().

See Also

yml() get_yml_defaults()

Other yml: asis_yaml_output(), bib2yml(), draw_yml_tree(), has_field(), read_json(), use_yml_file(), use_yml(), yml_author(), yml_blogdown_opts(), yml_bookdown_opts(), yml_citations(), yml_clean(), yml_distill_opts(), yml_latex_opts(), yml_output(), yml_pagedown_opts(), yml_params(), yml_pkgdown(), yml_reference(), yml_replace(), yml_resource_files(), yml_rsconnect_email(), yml_rticles_opts(), yml_runtime(), yml_site_opts(), yml_toc(), yml_vignette()


ymlthis documentation built on Aug. 5, 2022, 5:23 p.m.