Include a YAML header in write2

Source: R/yaml.R

Include a YAML header in write2

yaml(...)

# S3 method for yaml
print(x, ...)

# S3 method for yaml
c(..., recursive = FALSE)

is.yaml(x)

Arguments

...

For yaml(), arguments to be bundled into a list and passed to as.yaml. For print.yaml(), extra arguments. For c.yaml(), "yaml" objects to be concatenated.
x

An object of class "yaml".
recursive

Not in use at this time.

Value

A text string of class "yaml".

See also

as.yaml, write2

Author

Ethan Heinzen, adapted from an idea by Brendan Broderick

Examples

x <- yaml(title = "My cool title", author = "Ethan P Heinzen")
x

#> ---
#> title: My cool title
#> author: Ethan P Heinzen
#> ---
y <- yaml("header-includes" = list("\\usepackage[labelformat=empty]{caption}"))
y

#> ---
#> header-includes:
#> - \usepackage[labelformat=empty]{caption}
#> ---
c(x, y)

#> ---
#> title: My cool title
#> author: Ethan P Heinzen
#> header-includes:
#> - \usepackage[labelformat=empty]{caption}
#> ---