metadata {rmarkdown} | R Documentation

## The YAML metadata of the current R Markdown document

### Description

The object `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. `rmarkdown::metadata$title` (the title of the document), `rmarkdown::metadata$author`, and `rmarkdown::metadata$foo` (if you have a YAML field named `foo`), etc.

### Format

An object of class `list` of length 0.

### Examples

    rmarkdown::metadata

[Package rmarkdown version 1.12 Index]