GitHub显示README.rmd中的所有代码块（尽管include=FALSE）

我目前正在为一个项目编写文档。我使用

knitr

和R标记来编写自述文件。点击RStudio中的“Knit HTML”按钮，会生成我所期望的HTML

但是，将README.rmd推送到GitHub会导致您在上面的链接后看到页面下方的内容。例如，最顶层的代码块在README.rmd文件中声明如下：

```{r global_options, include = FALSE}
library(knitr)
options(width = 120)
opts_chunk$set(fig.width = 12, fig.height = 8, fig.path = 'Figs/',
               include = TRUE, warning = FALSE, message = FALSE)
```

但是，在这种情况下，第一行代码中的

include=FALSE

语句将被忽略，并且应该隐藏的代码片段将显示在引用的GitHub页面上。此外，尽管

选择chunk$set（…，include=TRUE）

，但结果（例如来自

plot（）

，

head（）

）不会可视化

---

有没有人遇到过类似的问题，我可以帮助我在GitHub上正确显示自述文件，即RStudio处理自述文件的方式？

您试图在GitHub上发布的自述文件应该是一个简单的标记文档，即

.md

文件，而不是原始的

.rmd

。因此，首先使用knitr（在R内）编织

.rmd

，如下所示：

knit(input="readme.rmd", output = "readme.md") #see ?knit for more options

---

这将评估源

.rmd

中指定的全局和区块选项，并生成相应格式的

.md

，github可以轻松呈现该选项。

有关使用

.rmd

生成

.md

的详细信息，请参阅的

自述.rmd

部分

---

您还可以让devtools使用

devtools:：use_readme\u rmd（）

为您的包自动设置此选项。我不知道这么简单。谢谢（：Oh@Shekeine，我忘了问：有没有办法在我的README.rmd文件中直接实现

knit

语句，并在点击“knit HTML”时自动转换它，还是每次我都必须从控制台手动执行它？在

knit（）

或点击“knit HTML”时执行R命令可以包含在

.rmd

中，方法是将它们括在双反引号中。但是，在

中编写
knit（废话废话）
。rmd

可能会让您陷入无限循环：-），我从来没有尝试过，所以不太确定：您可以，但我无法预见理想的结果。或者，如果您使用Rstudio，您可以要求knitr在生成html后“保留标记源文件”。此选项可以在Knitr设置（rstudio中

advanced

选项卡下的

knit html

旁边的小齿轮）中启用。请注意，“Keep markdown source file”可用于html输出，但不可用于笔记本电脑输出。遵循Hadley的书，我在Rmd文件中加载自己的包以演示其使用时遇到问题。事实上，该软件包正在开发中，因此没有安装在我的机器上，knitr也可以使用。如何解决这个问题？使用

devtools:：dev_mode（）

并安装该软件包。您需要安装该软件包来构建vignette。