fig_path {knitr}R Documentation

Path for figure files

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

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

Arguments

suffix

a suffix of the filename; if it is not empty, nor does it 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 (by default the internal chunk option fig.cur if 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

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

[Package knitr version 1.15.20 Index]