File: output_metadata.Rd

package info (click to toggle)
r-cran-rmarkdown 2.20%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 8,028 kB
  • sloc: javascript: 5,656; sh: 24; makefile: 17
file content (15 lines) | stat: -rw-r--r-- 629 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/render.R
\docType{data}
\name{output_metadata}
\alias{output_metadata}
\title{The output metadata object}
\description{
This object provides a mechanism for users to attach metadata as an attribute
(named \code{rmd_output_metadata}) of the returned value of
\code{\link{render}()}. The initial value of the metadata comes from in the
\code{rmd_output_metadata} field of the YAML frontmatter of an R Markdown
document. The metadata can be queried via the
\code{output_metadata$get()} method, and modified via the
\code{output_metadata$set()} method.
}