R markdown笔记04-knitr02
@[toc]( <center> knitr翻译02)
title: "Untitled"
author: "ks_c"
date: "2021/1/31"
output: html_document
本次翻译接下来三节:
Cache
1.cache
-
cache
: (FALSE
; logical) Whether to cache a code chunk.
When evaluating code chunks for the second time, the cached chunks are skipped (unless they have been modified), but the objects created in these chunks are loaded from previously saved databases (.rdb
and.rdx
files), and these files are saved when a chunk is evaluated for the first time, or when cached files are not found (e.g., you may have removed them by hand).
Note that the filename consists of the chunk label with an MD5 digest of the R code and chunk options of the code chunk, which means any changes in the chunk will produce a different MD5 digest, and hence invalidate the cache. See more information on this page.
(默认为FALSE;逻辑)是否缓存代码块。
当第二次运行代码块时,将跳过缓存的块(除非已对其进行修改),但是在这些块中创建的对象是从先前保存的数据库(.rdb和.rdx文件)中加载的,这些第一次运行块时或未找到缓存文件时(例如,您可能已手动删除它们),文件将被保存。
请注意,文件名由带有R代码的MD5摘要和代码块的块选项的块标签组成,这意味着该块中的任何更改都会产生不同的MD5摘要,从而使缓存无效。
2. cache.path
-
cache.path
: ('cache/'
; character) A prefix to be used to generate the paths of cache files. For R Markdown, the default value is based on the input filename, e.g., the cache paths for the chunk with the labelFOO
in the fileINPUT.Rmd
will be of the formINPUT_cache/FOO_*.*
.
('cache /'
; 字符串)用于生成缓存文件路径的前缀。 对于R Markdown,默认值基于输入文件名,例如,文件INPUT.Rmd中标签为FOO''的块的缓存路径将采用
INPUT_cache / FOO _ 。''的形式。
3. cache.vars
-
cache.vars
: (NULL
; character) A vector of variable names to be saved in the cache database. By default, all variables created in the current chunks are identified and saved, but you may want to manually specify the variables to be saved, because the automatic detection of variables may not be robust, or you may want to save only a subset of variables.
(默认NULL,字符)要保存在缓存数据库中的变量名的向量。 默认情况下,将识别并保存在当前块中创建的所有变量,但是您可能希望手动指定要保存的变量,因为自动检测变量可能不够可靠,或者您可能只想保存一部分变量
4. cache.globals
-
cache.globals
: (NULL
; character) A vector of the names of variables that are not created from the current chunk. This option is mainly forautodep = TRUE
to work more precisely—a chunkB
depends on chunkA
when any ofB
’s global variables areA
’s local variables. In case the automatic detection of global variables in a chunk fails, you may manually specify the names of global variables via this option (see #1403for an example).
(默认为NULL
;字符串)不是从当前块创建的变量名的向量。 此选项主要是为了使autodep = TRUE更精确地工作---当B模块的变量是A模块的变量时,B依靠A。 如果自动检测块中的全局变量失败,则可以通过此选项手动指定全局变量的名称
5. cache.lazy
-
cache.lazy
: (TRUE
; logical) Whether tolazyLoad()
or directlyload()
objects. For very large objects, lazyloading may not work, socache.lazy = FALSE
may be desirable (see #572).
延迟加载(默认为T)是要lazyLoad()还是直接是load()对象。 对于非常大的对象,延迟加载可能不起作用,因此可能需要``cache.lazy = FALSE''
6. cache.comments
-
cache.comments
: (NULL
; logical) IfFALSE
, changing comments in R code chunks will not invalidate the cache database.
(NULL;逻辑)如果为FALSE,则在R代码块中更改注释不会使高速缓存数据库无效
7. cache.rebuild
-
cache.rebuild
: (FALSE
; logical) IfTRUE
, reevaluate the chunk even if the cache does not need to be invalidated. This can be useful when you want to conditionally invalidate the cache, e.g.,cache.rebuild = !file.exists("some-file")
can rebuild the chunk whensome-file
does not exist (see #238).
(FALSE
;逻辑)如果为``TRUE'',则即使不需要使缓存无效也要重新运行源码块。 当您想有条件地使缓存无效时,这很有用,例如,cache.rebuild =!file.exists(“ some-file”)
可以在不存在some-file`的情况下重建块
8. dependson
-
dependson
: (NULL
; character or numeric) A character vector of chunk labels to specify which other chunks this chunk depends on. This option applies to cached chunks only—sometimes the objects in a cached chunk may depend on other cached chunks, so when other chunks are changed, this chunk must be updated accordingly.
dependson
:(NULL
;字符或数字)块标签的字符向量,用于指定该块所依赖的其他块。 此选项仅适用于高速缓存的块-有时,高速缓存的块中的对象可能取决于其他高速缓存的块,因此,在更改其他大块时,必须相应地更新该大块。 -
If
dependson
is a numeric vector, it means the indices of chunk labels, e.g.,dependson = 1
means this chunk depends on the first chunk in the document, anddependson = c(-1, -2)
means it depends on the previous two chunks (negative indices stand for numbers of chunks before this chunk, and note they are always relative to the current chunk).如果Dependson是数字向量,则表示块标签的索引,例如Dependson = 1表示此块取决于文档中的第一个块,而Dependson = c(-1,-2)表示 它取决于前两个块(负索引代表该块之前的块数,请注意,它们始终相对于当前块)。 -
Please note this option does not work when set as a global chunk option via
opts_chunk$set()
; it must be set as a local chunk option.请注意,通过opts_chunk $ set()设置为全局块选项时,此选项不起作用; 必须将其设置为本地块选项。 -
autodep
: (FALSE
; logical) Whether to analyze dependencies among chunks automatically by detecting global variables in the code (may not be reliable), sodependson
does not need to be set explicitly.autodep:(FALSE;逻辑)是否通过检测代码中的全局变量来自动分析块之间的依赖关系(可能不可靠),所以不需要显式设置dependson。
Plots
-
fig.path
: ('figure/'
; character) A prefix to be used to generate figure file paths.fig.path
and chunk labels are concatenated to generate the full paths. It may contain a directory likefigure/prefix-
; the directory will be created if it does not exist.('figure /'; character)用于生成图形文件路径的前缀。 fig.path和块标签被串联以生成完整路径。 它可能包含一个目录,如图/前缀-; 如果目录不存在,将创建该目录。 -
fig.keep
: ('high'
; character) How plots in chunks should be kept. Possible values are as follows:如何保存代码块中的图
* `high`: Only keep high-level plots (merge low-level changes into high-level plots).仅保留高级绘图,低级图被融合进高级图中
* `none`: Discard all plots.不保存
* `all`: Keep all plots (low-level plot changes may produce new plots).保存所有图
* `first`: Only keep the first plot.只保留第一张图
* `last`: Only keep the last plot.只保留最后一张图
* If set to a numeric vector, the values are indices of (low-level) plots to keep. 数值向量为保存第几张图
Low-level plotting commands include `lines()` and `points()`, etc. To better understand `fig.keep`, consider the following chunk:
```
```{r, test-plot}
plot(1) # high-level plot
abline(0, 1) # low-level change
plot(rnorm(10)) # high-level plot
# many low-level changes in a loop (a single R expression)
for(i in 1:10) {
abline(v = i, lty = 2)
}
```
```
Normally this produces 2 plots in the output (because `fig.keep = 'high'`). For `fig.keep = 'none'`, no plots will be saved. For `fig.keep = 'all'`, 4 plots are saved. For `fig.keep = 'first'`, the plot produced by `plot(1)` is saved. For `fig.keep = 'last'`, the last plot with 10 vertical lines is saved.
-
fig.show
: ('asis'
; character) How to show/arrange the plots. Possible values are as follows:如何显示/安排图。 可能的值如下:
该部分类似文字输出部分的设置。
* `asis`: Show plots exactly in places where they were generated (as if the code were run in an R terminal).该在哪在哪
* `hold`: Hold all plots and output them at the end of a code chunk.所有图都在最后
* `animate`: Concatenate all plots into an animation if there are multiple plots in a chunk.多个图变成动画连续播放
* `hide`: Generate plot files but hide them in the output document. 隐藏
-
dev
: ('pdf'
for LaTeX output and'png'
for HTML/Markdown; character) The graphical device to generate plot files. All graphics devices in base R and those in Cairo, cairoDevice, svglite, ragg, and tikzDevice are supported, e.g.,pdf
,png
,svg
,jpeg
,tiff
,cairo_pdf
,CairoJPEG
,CairoPNG
,Cairo_pdf
,Cairo_png
,svglite
,ragg_png
,tikz
, and so on. Seenames(knitr:::auto_exts)
for the full list. Besides these devices, you can also provide a character string that is the name of a function of the formfunction(filename, width, height)
. The units for the image size are always inches (even for bitmap devices, in which DPI is used to convert between pixels and inches).
输出格式。(对于LaTeX输出是pdf'',对于HTML / Markdown是
png''; 字符)用于生成绘图文件的图形设备。
支持Base R中的所有图形设备以及** Cairo , cairoDevice , svglite , ragg 和 tikzDevice *中的所有图形设备,例如pdf,png ,svg,jpeg,tiff,cairo_pdf,cairoJPEG,cairoPNG,cairo_pdf,cairo_png,svglite,ragg_png,tikz等。 有关完整列表,请参见names(knitr ::: auto_exts)
。 除了这些设备之外,您还可以提供一个字符串,该字符串是形式为function(文件名,宽度,高度)的函数的名称。 图像大小的单位始终是英寸(即使对于位图设备,其中DPI用于在像素和英寸之间进行转换)。
The chunk options `dev`, `fig.ext`, `fig.width`, `fig.height`, and `dpi` can be vectors (shorter ones will be recycled), e.g., `dev = c('pdf', 'png')` creates a `PDF` and a `PNG`file for the same plot.201 / 5000。dev,fig.ext,fig.width,fig.height和dpi的块选项可以是向量(较短的将被回收),例如dev = c('pdf' ,'png')`为同一图创建一个PDF文件和一个PNG文件。
-
dev.args
: (NULL
; list) More arguments to be passed to the device, e.g.,dev.args = list(bg = 'yellow', pointsize = 10)
fordev = 'png'
. This option depends on the specific device (see the device documentation). Whendev
contains multiple devices,dev.args
can be a list of lists of arguments, and each list of arguments is passed to each individual device, e.g.,dev = c('pdf', 'tiff'), dev.args = list(pdf = list(colormodel = 'cmyk', useDingats = TRUE), tiff = list(compression = 'lzw'))
.dev.args:(
NULL; list)更多的参数要传递给设备,例如,
dev.args = list(bg ='yellow',pointssize = 10)。 此选项取决于特定的设备(请参阅设备文档)。 当
dev包含多个设备时,
dev.args可以是参数列表的列表,并且每个参数列表都传递给每个单独的设备,例如,
dev = c('pdf','tiff'), dev.args = list(pdf = list(颜色模型='cmyk',useDingats = TRUE),tiff = list(压缩='lzw'))` -
fig.ext
: (NULL
; character) File extension of the figure output. IfNULL
, it will be derived from the graphical device; seeknitr:::auto_exts
for details.fig.ext
:(NULL
;字符)图形输出的文件扩展名。 如果为NULL,它将从图形设备派生; 有关详细信息,请参见knitr ::: auto_exts
。 -
dpi
: (72
; numeric) The DPI (dots per inch) for bitmap devices (dpi * inches = pixels
).72;数字)位图设备的DPI(每英寸点数)(dpi *英寸=像素)。 -
fig.width
,fig.height
: (both are7
; numeric) Width and height of the plot (in inches), to be used in the graphics device.
图片的高度和宽度,英寸 -
fig.asp
: (NULL
; numeric) The aspect ratio of the plot, i.e., the ratio of height/width. Whenfig.asp
is specified, the height of a plot (the chunk optionfig.height
) is calculated fromfig.width * fig.asp
.
宽高比。(NULL
;数字)绘图的长宽比,即高/宽比。 当指定fig.asp
时,图的高度(fig.height块选项)是从fig.width * fig.asp
中计算出来的。 -
fig.dim
: (NULL
; numeric) A numeric vector of length 2 to providefig.width
andfig.height
, e.g.,fig.dim = c(5, 7)
is a shorthand offig.width = 5, fig.height = 7
. If bothfig.asp
andfig.dim
are provided,fig.asp
will be ignored (with a warning).
(NULL
;数字)一个长度为2的数字向量,以提供fig.width
和fig.height
,例如fig.dim = c(5,7)
是简写形式 图宽度= 5,图高度= 7。 如果同时提供了fig.asp
和fig.dim
,则fig.asp
将被忽略(带有警告)。 -
out.width
,out.height
: (NULL
; character) Width and height of the plot in the output document, which can be different with its physicalfig.width
andfig.height
, i.e., plots can be scaled in the output document. Depending on the output format, these two options can take special values. For example, for LaTeX output, they can be.8\\linewidth
,3in
, or8cm
; for HTML, they may be300px
. For.Rnw
documents, the default value forout.width
will be changed to\\maxwidth
, which is defined on this page. It can also be a percentage, e.g.,'40%'
will be translated to0.4\linewidth
when the output format is LaTeX.
(NULL
;字符)输出文档中绘图的宽度和高度,可以与它的物理fig.width
和fig.height
不同,即 ,可以在输出文档中缩放绘图。 根据输出格式,这两个选项可以采用特殊值。 例如,对于LaTeX输出,它们可以是.8 \ linewidth,3in或8cm; 对于HTML,它们可能是300px。 对于.Rnw文档,out.width的默认值将更改为\ maxwidth,此值在此页面上定义。](https://yihui.org/knitr/demo/framed/ )也可以是一个百分比,例如,当输出格式为LaTeX时,40%''将转换为
0.4 \ linewidth''。 -
out.extra
: (NULL
; character) Extra options for figures. It can be an arbitrary string, to be inserted in\includegraphics[]
in LaTeX output (e.g.,out.extra = 'angle=90'
to rotate the figure by 90 degrees), or<img />
in HTML output (e.g.,out.extra = 'style="border:5px solid orange;"'
).(NULL
;字符)数字的额外选项。 它可以是任意字符串,可以插入LaTeX输出的\ includegraphics []中(例如,out.extra ='angle = 90'将图形旋转90度),或<img />` 在HTML输出中(例如,out.extra ='style =“ border:5px实心橙色;”')。 -
fig.retina
: (1
; numeric) This option only applies to HTML output. For Retina displays, setting this option to a ratio (usually 2) will change the chunk optiondpi
todpi * fig.retina
, andout.width
tofig.width * dpi / fig.retina
internally. For example, the physical size of an image is doubled, and its display size is halved whenfig.retina = fig.retina
:
(1; 数字)此选项仅适用于HTML输出。 对于[Retina显示器,](http://en.wikipedia.org/wiki/Retina_Display)将此选项设置为比率(通常为2)将将dpi''更改为
dpi * fig.retina'',然后 在内部将图宽到图宽 dpi /图视网膜。 例如,当fig.retina = 2
时,图像的物理尺寸增加了一倍,显示尺寸减半。 -
resize.width
,resize.height
: (NULL
; character) The width and height to be used in\resizebox{}{}
in LaTeX output. These two options are not needed unless you want to resize TikZ graphics, because there is no natural way to do it. However, according to the tikzDevice authors, TikZ graphics are not meant to be resized, to maintain consistency in style with other text in LaTeX. If only one of them isNULL
,!
will be used (read the documentation of graphicx if you do not understand this).
resize.width,resize.height
:(NULL
;字符)LaTeX输出中\ resizebox {} {}中要使用的宽度和高度。 除非您想要调整TikZ图形的大小,否则不需要这两个选项,因为没有自然的方法可以做到这一点。 但是,据tikzDevice 的作者称,TikZ图形并非要调整大小,以保持与LaTeX中其他文本的样式一致性。 如果其中只有一个为``NULL'',则将使用!!(如果您不了解,请阅读 graphicx **的文档)。 -
fig.align
: ('default'
; character) Alignment of figures in the output document. Possible values aredefault
,left
,right
, andcenter
. The default is not to make any alignment adjustments.
(`'default';; character)输出文档中图形的对齐。 可能的值为“默认”,“左”,“右”和“中心”。 默认设置是不进行任何对齐调整 -
fig.link
: (NULL
; character) A link to be added onto the figure. -
fig.env
: ('figure'
; character) The LaTeX environment for figures, e.g., you may setfig.env = 'marginfigure'
to get\begin{marginfigure}
. This option requiresfig.cap
be specified. -
fig.cap
: (NULL
; character) A figure caption. -
fig.alt
: (NULL
; character) The alternative text to be used in thealt
attribute of the<img>
tags of figures in HTML output. By default, the chunk optionfig.cap
will be used as the alternative text if provided. -
fig.scap
: (NULL
; character) A short caption. This option is only meaningful to LaTeX output. A short caption is inserted in\caption[]
, and usually displayed in the “List of Figures” of a PDF document. -
fig.lp
: ('fig:'
; character) A label prefix for the figure label to be inserted in\label{}
. The actual label is made by concatenating this prefix and the chunk label, e.g., the figure label for ````{r, foo-plot}will be
fig:foo-plotby default. lable{}中可以插入图形标签的前缀。 实际的标签是通过该前缀和块标签制成的,例如,{r,foo-plot}的图形标签默认情况下将为
fig:foo-plot`。 -
fig.pos
: (''
; character) A character string for the figure position arrangement to be used in\begin{figure}[]
. -
fig.subcap
: (NULL
) Captions for subfigures. When there are multiple plots in a chunk, and neitherfig.subcap
norfig.cap
isNULL
,\subfloat{}
will be used for individual plots (you need to add\usepackage{subfig}
in the preamble). See 067-graphics-options.Rnw for an example. -
fig.ncol
: (NULL
; integer) The number of columns of subfigures; see this issue for examples (note thatfig.ncol
andfig.sep
only work for LaTeX output). -
fig.sep
: (NULL
; character) A character vector of separators to be inserted among subfigures. Whenfig.ncol
is specified,fig.sep
defaults to a character vector of which every N-th element is\newline
(whereN
is the number of columns), e.g.,fig.ncol = 2
meansfig.sep = c('', '', '\\newline', '', '', '\\newline', '', ...)
. -
fig.process
: (NULL
; function) A function to post-process figure files. It should take the path of a figure file, and return the (new) path of the figure to be inserted in the output. If the function contains theoptions
argument, the list of chunk options will be passed to this argument. -
fig.showtext
: (NULL
; logical) IfTRUE
, callshowtext::showtext_begin()
before drawing plots. See the documentation of the showtext package for details. -
external
: (TRUE
; logical) Whether to externalize tikz graphics (pre-compile tikz graphics to PDF). It is only used for thetikz()
device in the tikzDevice package (i.e., whendev='tikz'
), and it can save time for LaTeX compilation. -
sanitize
: (FALSE
; character) Whether to sanitize tikz graphics (escape special LaTeX characters). See the documentation of the tikzDevice package.
There are two hidden options that are not designed to be set by users: fig.cur
(the current figure number or index when there are multiple figures), and fig.num
(the total number of figures in a chunk). The purpose of these two options is to help knitr deal with the filenames of multiple figures as well as animations. In some cases, we can make use of them to write animations into the output using plot files that are saved manually (see the graphics manual for examples).
Animation
-
interval
: (1
; numeric) Time interval (number of seconds) between animation frames.默认为1秒,动画帧之间的时间间隔(秒数) -
animation.hook
: (knitr::hook_ffmpeg_html
; function or character) A hook function to create animations in HTML output; the default hook uses FFmpeg to convert images to a WebM video.(默认为knitr :: hook_ffmpeg_html
;函数或字符)用于在HTML输出中创建动画的钩子函数; 默认挂钩使用FFmpeg将图像转换为WebM视频。
- Another hook function is
knitr::hook_gifski
based on the gifski package to create GIF animations.另一个挂钩函数是基于** gifski **包的knitr :: hook_gifski`来创建GIF动画。
-
This option can also take a character string
'ffmpeg'
or'gifski'
as a shorthand of the corresponding hook function, e.g.,animation.hook = 'gifski'
meansanimation.hook = knitr::hook_gifski
.此选项还可以将字符串'ffmpeg'
或'gifski'作为对应的钩子函数的简写,例如,animation.hook ='gifski'意味着animation.hook = knitr :: hook_gifski 。 -
aniopts
: ('controls,loop'
; character) Extra options for animations; see the documentation of the LaTeX animate package.
-
ffmpeg.bitrate
(1M
; character) To be passed to the-b:v
argument of FFmpeg to control the quality of WebM videos.动画的额外选项; 请参阅LaTeX ** animate **软件包的文档 -
ffmpeg.format
(webm
; character) The video format of FFmpeg, i.e., the filename extension of the video.webm
; character)FFmpeg的视频格式,即视频的文件扩展名。