Knitr:spin - 如何在不手动添加 #' 每行的情况下添加文本？

Question

我的理解是，knitr:spin 允许我处理我的普通、普通、常规的良好 R 脚本，同时保持生成理解 Markdown 语法的完整文档的能力。 （见https://yihui.name/knitr/demo/stitch/）

确实，Rstudio 中的 rmarkdown 功能虽然超级简洁，但实际上确实很麻烦，因为

• 我需要复制我的代码并将其分成几块，这非常无聊 + 效率低下，因为很难跟踪代码更改。
• 除此之外，rmarkdown 无法读取我当前的工作空间。这有点令人惊讶，但事实就是如此。

总而言之，这非常限制...有关相关讨论，请参见此处Is there a way to knitr markdown straight out of your workspace using RStudio?。

正如这里所讨论的 (http://deanattali.com/2015/03/24/knitrs-best-hidden-gem-spin/)，spin 似乎是解决方案。

确实，knitr:spin 语法如下所示：

#' This is a special R script which can be used to generate a report. You can
#' write normal text in roxygen comments.
#'
#' First we set up some options (you do not have to do this):

#+ setup, include=FALSE
library(knitr)

在常规工作区中！

但是注意每一行文本前面是如何以#' 开头的。

我的问题是，在每行文本之后添加#' 也是非常低效的。有没有办法自动做到这一点？

假设我选择了一整段文本，而 rstudio 将 #' 每行添加？也许本着与注释一大段代码行相同的精神？

我错过了什么吗？

谢谢！

Answer 1

在 RStudio v 1.1.28 中，当我在我的机器（Ubuntu Linux 16.04LTS）上输入 *.R 文件时，以 #' 开头的一行会导致下一行以 #' 开头。

所以只要你用它开始一个文本块，它就会继续。但是对于以前存在的 R 脚本，看起来你必须使用find -> replace，或者编写一个函数来修改所需的文件，这在一个非常简单的测试中对我有用。

comment_replace <- function(in_file, out_file = in_file){
  in_text <- scan(file = in_file, what = character(), sep = "\n")
  out_text <- gsub("^# ", "#' ", in_text)
  cat(out_text, sep = "\n", file = out_file)
}

我要注意，这个函数不检查预先存在的#'，你会想把它内置进去。我修改了它，使它不应该通过添加一个太多来替换它们正则表达式中的空格。

Answer 2

使用 RMarkdown 文档，您可以编写如下内容：

As you can see I have some fancy code below, and text right here.

```{r setup}
# R code here
library(ggplot2)
```

And I have more text here...

This gist 简要介绍了 RMarkdown 和 knitr 的功能。我想你并不完全理解 RMarkdown 到底是什么，它是一个中间夹着 R 的 markdown 文档，而不是（如你所说的）中间夹着 markdown 的 R 脚本。

---

编辑：对于那些不赞成投票的人，请阅读下面的 cmets... OP 没有指定他之前使用的是 spin。