ReadRmdFrontMatter {hivPlatform}R Documentation

ReadRmdFrontMatter

Description

Reads YAML front matter from a Rmd file.

Usage

ReadRmdFrontMatter(filePath, section = NULL)

Arguments

filePath

Path to the source RMarkdown file. Required.

section

Name of section of the front matter to return. If not specified, then the whole specification is returned, otherwise only the specified section. Optional. Default = NULL.

Value

list object

Examples

## Not run: 
ReadRmdFrontMatter(filePath)

## End(Not run)


[Package hivPlatform version 2.0.5 Index]