r - 编制 Rmd 文件时如何请求提前退出？

Question

假设您有一个无法清晰呈现的 R markdown 文档。

我知道您可以将 knitr block 选项 error 设置为 TRUE 以请求继续评估，即使存在错误也是如此。您可以通过 error = TRUE 对单个 block 执行此操作，或者通过 knitr::opts_chunk$set(error = TRUE) 以更全局的方式执行此操作。

但有时存在的错误对于编织过程来说仍然是致命的。我最近遇到的两个例子:尝试 unlink() 当前工作目录(哎呀!)并在 RStudio 运行时从内联 R 代码调用 rstudioapi::getVersion()无法使用。是否有对此类错误的一般描述，即那些超出 error = TRUE 范围的错误？有没有办法容忍内联 R 代码与 block 中的错误？

此外，在这种情况下是否有更多官方方法可以提前停止编织或自动调试？

Answer 1

要提前退出编织过程，您可以在源文档中的任何位置(在代码块或内联表达式中)使用函数 knitr::knit_exit() 。一旦调用 knit_exit()，knitr 将忽略文档的所有其余部分并写出迄今为止收集的结果。

目前无法容忍内联 R 代码中的错误。您需要确保内联 R 代码始终运行而不会出现错误¹。如果确实发生错误，您应该会在控制台的 knitr 日志中看到产生错误的行范围，格式为 Quitting fromlines x1-x2 (filename.Rmd).然后您可以转到文件 filename.Rmd 并查看从 x1 到 x2 的行有什么问题。同样的情况也适用于带有 block 选项 error = FALSE 的代码块。

除了上面提到的错误类型之外，找到问题的根源可能很棘手。例如，当您无意中 unlink() 当前目录时，它不应该停止编织过程，因为 unlink() 无论如何都会成功。编织过程后您可能会遇到问题，例如 LaTeX/HTML 找不到输出图形文件。在这种情况下，您可以尝试将 knit_exit() 应用于文档中的所有代码块。实现此目的的一种方法是设置一个 block 钩子(Hook)以在特定 block 之后运行 knit_exit() 。下面是使用线性搜索的示例(您可以通过使用二分法来改进它):

#' Render an input document chunk by chunk until an error occurs
#' 
#' @param input the input filename (an Rmd file in this example)
#' @param compile a function to compile the input file, e.g. knitr::knit, or
#'   rmarkdown::render
knit_debug = function(input, compile = knitr::knit) {
  library(knitr)
  lines = readLines(input)
  chunk = grep(all_patterns$md$chunk.begin, lines)  # line number of chunk headers

  knit_hooks$set(debug = function(before) {
    if (!before) {
      chunk_current <<- chunk_current + 1
      if (chunk_current >= chunk_num) knit_exit()
    }
  })

  opts_chunk$set(debug = TRUE)

  # try to exit after the i-th chunk and see which chunk introduced the error
  for (chunk_num in seq_along(chunk)) {
    chunk_current = 0  # a chunk counter, incremented after each chunk
    res = try(compile(input))
    if (inherits(res, 'try-error')) {
      message('The first error came from line ', chunk[chunk_num])
      break
    }
  }
}

<小时/>

1. 这是设计使然。我认为对代码块使用 error = TRUE 是个好主意，因为有时我们想要显示错误，例如出于教学目的。但是，如果我也允许内联代码出现错误，那么作者可能无法识别内联代码中的 fatal error 。内联代码通常用于嵌入内联值，并且我认为如果内联值是错误，那么它没有多大意义。想象一下报告中的一句话，例如The P-value of my test is ERROR，如果knitr没有发出错误信号，则需要作者阅读报告非常仔细地输出以发现这个问题。我认为必须依靠人眼来发现此类错误是一个坏主意。