knitr (version 1.17)

knit_params_yaml: Extract knit parameters from YAML text

Description

This function reads the YAML front-matter that has already been extracted from a document and returns a list of any parameters declared there.

Usage

knit_params_yaml(yaml, evaluate = TRUE)

Arguments

yaml

Character vector containing the YAML text

evaluate

If TRUE, expression values embedded within the YAML will be evaluated. This is the default. When FALSE, parameters defined by an expression will have the parsed expression in its value field.

Value

List of objects of class knit_param that correspond to the parameters declared in the params section of the YAML. See knit_params for a full description of these objects.

See Also

knit_params