R Rtangle Stangle 的 R 驱动程序

说明

一名司机Stangle提取R代码块。值得注意的是所有RtangleSetup()参数可以用作参数Stangle()称呼。

用法

Rtangle()
RtangleSetup(file, syntax, output = NULL, annotate = TRUE,
             split = FALSE, quiet = FALSE, drop.evalFALSE = FALSE, ...)

参数

file	Sweave 源文件的名称。参见 Sweave 对应参数的说明。
syntax	类 SweaveSyntax 的对象。
output	使用的输出文件的名称，除非split = TRUE：请参阅“详细信息”。
annotate	逻辑或 function 。当为 true 时，默认情况下，代码块由指定代码块的名称和行号的注释行分隔。如果FALSE 则省略装饰注释。或者，annotate 可以是一个函数，请参阅“块注释”部分。
split	将每个代码块的输出拆分为一个文件？
quiet	逻辑上抑制所有进度消息。
drop.evalFALSE	逻辑性；当为 false 时，默认情况下，所有带有选项 eval = FALSE 的块都会在输出中被注释掉；否则(drop.evalFALSE = TRUE)它们将被完全省略。
...	“支持的选项”中列出的其他选项的附加命名参数设置默认值。

细节

除非split = TRUE，输出文件的默认名称是basename(file)具有与 Sweave 语法相对应的扩展名(例如，‘净水量', '斯特克斯') 取而代之 'R’。文件名"stdout"和"stderr"分别解释为输出和消息连接。

如果选择拆分(包括文件中的选项)，则每个块都会写入一个单独的文件，其扩展名是‘engine’(默认为“.R’)。

请注意，此驱动程序不仅仅只是逐字提取代码块，因为代码块可能会重复使用较早的块。

块注释(annotate)

默认情况下 annotate = TRUE ，注释是其中一种形式

###################################################
### code chunk number 3: viewport
###################################################

###################################################
### code chunk number 18: grid.Rnw:647-648
###################################################

###################################################
### code chunk number 19: trellisdata (eval = FALSE)
###################################################

使用块标签(如果存在，即在源中指定时)或文件名和行号。

annotate 可以是带有形式参数 (options, chunk, output) 的函数，例如产生不太占主导地位的块注释；请参阅 Rtangle()$runcode 如何调用它而不是默认值。

支持的选项

Rtangle 支持以下代码块选项(括号中的值显示默认值)：

引擎：

字符串("R")。仅处理engine等于"R"或"S"的块。

保留来源：

逻辑(TRUE)。如果keep.source == TRUE原始源被复制到文件中。否则，输出解析后的源。

评估：

逻辑(TRUE)。如果是 FALSE ，则代码块将被复制但被注释掉。

字首

如果 split = TRUE 使用。请参阅prefix.string。

前缀.字符串：

一个字符串，默认是源文件的名称(不带扩展名)。如果块没有标签，或者具有标签和 prefix = TRUE ，则使用 split = TRUE 作为文件名的前缀。请注意，它用作文件名的一部分，因此需要可移植。

show.line.nos

逻辑(FALSE)。输出是否应该用注释来注释，以显示块的第一个代码行的行号？

例子

nmRnw <- "example-1.Rnw"
exfile <- system.file("Sweave", nmRnw, package = "utils")
## Create R source file
Stangle(exfile)
nmR <- sub("Rnw$", "R", nmRnw) # the (default) R output file name
if(interactive()) file.show("example-1.R")

## Smaller R source file with custom annotation:
my.Ann <- function(options, chunk, output) {
  cat("### chunk #", options$chunknr, ": ",
      if(!is.null(ol <- options$label)) ol else .RtangleCodeLabel(chunk),
      if(!options$eval) " (eval = FALSE)", "\n",
      file = output, sep = "")
}
Stangle(exfile, annotate = my.Ann)
if(interactive()) file.show("example-1.R")

Stangle(exfile, annotate = my.Ann, drop.evalFALSE=TRUE)
if(interactive()) file.show("example-1.R")

作者

Friedrich Leisch and R-core.

也可以看看

“Sweave User Manual”，utils 包中的小插图。

Sweave , RweaveLatex