File: metadata.Rd

package info (click to toggle)
r-cran-rmarkdown 1.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 8,228 kB
  • sloc: sh: 24; makefile: 10
file content (18 lines) | stat: -rw-r--r-- 642 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/render.R
\docType{data}
\name{metadata}
\alias{metadata}
\title{The YAML metadata of the current R Markdown document}
\format{An object of class \code{list} of length 0.}
\description{
The object \code{metadata} stores the YAML metadata of the current R Markdown
document as a list, which you may use in the R code chunks, e.g.
\code{rmarkdown::metadata$title} (the title of the document),
\code{rmarkdown::metadata$author}, and \code{rmarkdown::metadata$foo} (if you
have a YAML field named \code{foo}), etc.
}
\examples{
rmarkdown::metadata
}
\keyword{datasets}