fig_path: Path for figure files

Description Usage Arguments Value Note Examples

View source: R/utils.R

Description

The filename of figure files is the combination of options fig.path and label. This function returns the path of figures for the current chunk by default.

Usage

1
fig_path(suffix = "", options = opts_current$get(), number)

Arguments

suffix

A filename suffix; if it is non-empty and does not contain a dot ., it will be treated as the filename extension (e.g. png will be used as .png)

options

A list of options; by default the options of the current chunk.

number

The current figure number. The default is the internal chunk option fig.cur, if this is available.

Value

A character vector of the form ‘fig.path-label-i.suffix’.

Note

When there are special characters (not alphanumeric or - or _) in the path, they will be automatically replaced with _. For example, ‘a b/c.d-’ will be sanitized to ‘a_b/c_d-’. This makes the filenames safe to LaTeX.

Examples

1
2
fig_path(".pdf", options = list(fig.path = "figure/abc-", label = "first-plot"))
fig_path(".png", list(fig.path = "foo-", label = "bar"), 1:10)

Example output

[1] "figure/abc-first-plot-1.pdf"
 [1] "foo-bar-1.png"  "foo-bar-2.png"  "foo-bar-3.png"  "foo-bar-4.png" 
 [5] "foo-bar-5.png"  "foo-bar-6.png"  "foo-bar-7.png"  "foo-bar-8.png" 
 [9] "foo-bar-9.png"  "foo-bar-10.png"

knitr documentation built on Jan. 27, 2021, 5:09 p.m.