Get and set code chunk options

Helper functions for obtaining or changing chunk options within an rmd object.

Usage

rmd_set_options(x, ...)

rmd_get_options(x, ..., defaults = list())

Arguments

x

An rmd_ast, rmd_tibble, or any rmd ast node object.

...

Either a collection of named values for the setter or a character values of the option names for the getter.

defaults

A named list of default values for the options.

Value

rmd_set_options returns the modified version of the original object.

rmd_get_options returns a list of the requested options (or all options if none are specified). Non-chunk nodes return NULL.

Examples

rmd = parse_rmd(system.file("examples/minimal.Rmd", package = "parsermd"))

str(rmd_get_options(rmd))
#> List of 12
#>  $ : NULL
#>  $ : NULL
#>  $ :List of 1
#>   ..$ include: chr "FALSE"
#>  $ : NULL
#>  $ : NULL
#>  $ : NULL
#>  $ : list()
#>  $ : list()
#>  $ : NULL
#>  $ : NULL
#>  $ :List of 1
#>   ..$ echo: chr "FALSE"
#>  $ : NULL
str(rmd_get_options(rmd), "include")
#> List of 12
#>  $ : NULL
#>  $ : NULL
#>  $ :List of 1
#>   ..$ include: chr "FALSE"
#>  $ : NULL
#>  $ : NULL
#>  $ : NULL
#>  $ : list()
#>  $ : list()
#>  $ : NULL
#>  $ : NULL
#>  $ :List of 1
#>   ..$ echo: chr "FALSE"
#>  $ : NULL

rmd_set_options(rmd, include = TRUE)
#> ├── YAML [4 fields]
#> ├── Heading [h1] - Setup
#> │   └── Chunk [r, 1 option, 1 line] - setup
#> └── Heading [h1] - Content
#>     ├── Heading [h2] - R Markdown
#>     │   ├── Markdown [6 lines]
#>     │   ├── Chunk [r, 1 option, 1 line] - cars
#>     │   └── Chunk [r, 1 option, 1 line] - unnamed-chunk-1
#>     └── Heading [h2] - Including Plots
#>         ├── Markdown [2 lines]
#>         ├── Chunk [r, 2 options, 1 line] - pressure
#>         └── Markdown [2 lines]