opts_chunk: Default and current chunk options

Description Usage Format Details Note References Examples

Description

Options for R code chunks. When running R code, the object opts_chunk (default options) is not modified by chunk headers (local chunk options are merged with default options), whereas opts_current (current options) changes with different chunk headers and it always reflects the options for the current chunk.

Usage

1
2
3

Format

An object of class list of length 6.

Details

Normally we set up the global options once in the first code chunk in a document using opts_chunk$set(), so that all latter chunks will use these options. Note the global options set in one chunk will not affect the options in this chunk itself, and that is why we often need to set global options in a separate chunk.

See str(knitr::opts_chunk$get()) for a list of default chunk options.

Note

opts_current should be treated as read-only and you are supposed to only query its values via opts_current$get(). Technically you could also call opts_current$set() to change the values, but you are not recommended to do so unless you understand the consequences.

References

Usage: https://yihui.name/knitr/objects/

A list of available options: https://yihui.name/knitr/options/#chunk_options

Examples

1
2
opts_chunk$get("prompt")
opts_chunk$get("fig.keep")

Example output

[1] FALSE
[1] "high"

knitr documentation built on Nov. 13, 2019, 1:07 a.m.