write_rmd: Writing R-Markdown Documents

In kamapu/yamlme: Writing 'YAML' Headers for 'R-Markdown' Documents

Writing R-Markdown Documents

Description

This function generates R-Markdown documents by including the settings as arguments of the function. Comments and pieces of header can be also added through the argument append.

Usage

write_rmd(object, ...)

## S3 method for class 'rmd_doc'
write_rmd(object, filename, ...)

Arguments

object	rmd_doc object used to write an Rmarkdown file. If header is missing, write_rmd() will fail with an error message.
...	Further arguments passed among methods (not yet used).
filename	A character value with the name of the file to be written. It is not necessary to include the extension *.Rmd in this argument. If missing, the function will use the name of the input object.

Value

A character vector of class rmd_doc and, if argument set for parameter filename, an Rmd file.

Examples

## Not run: 
my_document <- list(
  title = "Sample Document",
  author = "Miguel Alavarez",
  output = "html_document",
  body = txt_body(
    "# Intro",
    "",
    "This is just an example."
  )
)
my_document <- as(my_document, "rmd_doc")
write_rmd(my_document, filename = file.path(tempdir(), "example"))

## End(Not run)

kamapu/yamlme documentation built on June 29, 2024, 9:17 p.m.