~ubuntu-branches/debian/sid/r-cran-rmarkdown/sid

« back to all changes in this revision

Viewing changes to man/output_metadata.Rd

  • Committer: Package Import Robot
  • Author(s): Andreas Tille
  • Date: 2018-03-23 08:25:44 UTC
  • mfrom: (1.1.1)
  • Revision ID: package-import@ubuntu.com-20180323082544-wo1jbu46ryb61sfv
Tags: 1.9+dfsg-1
* New upstream version
* Standards-Version: 4.1.3
* debhelper 11
* DEP5 fix

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
% Generated by roxygen2: do not edit by hand
 
2
% Please edit documentation in R/render.R
 
3
\docType{data}
 
4
\name{output_metadata}
 
5
\alias{output_metadata}
 
6
\title{The output metadata object}
 
7
\description{
 
8
This object provides a mechanism for users to attach metadata as an attribute
 
9
(named \code{rmd_output_metadata}) of the returned value of
 
10
\code{\link{render}()}. The initial value of the metadata comes from in the
 
11
\code{rmd_output_metadata} field of the YAML frontmatter of an R Markdown
 
12
document. The metadata can be queried via the
 
13
\code{output_metadata$get()} method, and modified via the
 
14
\code{output_metadata$set()} method.
 
15
}