print: Print Method for rmd_doc

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

Print Method for rmd_doc

Description

Quick display for rmd_doc objects. This method also defines the way how objects are displayed in the console.

Usage

## S3 method for class 'rmd_doc'
print(x, maxlines = 10, ...)

Arguments

x	An object of class rmd_doc.
maxlines	An integer value indicating the number of lines used for the display. Longer documents will be truncated.
...	Further arguments passed among methods (not yet in use).

Value

A display of the resulting R-Markdown document in the console.

Examples

## Document without header
my_document <- read_rmd(
  file = file.path(path.package("yamlme"), "taxlistjourney.Rmd"),
  skip_head = TRUE
)
my_document

## Add header using update
my_document <- update(my_document,
  title = "A journey in rOpenSci",
  author = "Miguel Alvarez",
  output = "html_document"
)
my_document

## Header only
my_document$body <- NULL
my_document

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