GitHub显示来自README.rmd的所有代码块(尽管include = FALSE)

Question

我目前正在为GitHub上托管的R包编写文档.我knitr与R Markdown一起使用来编写README文件.点击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页面上.此外,结果(例如,从plot(),head())不,尽管可视化opts_chunk$set(..., include = TRUE).

有没有人遇到类似的问题,我可以帮助我在GitHub上显示正确的README文档,即RStudio处理它的方式吗？

Answer 1

您尝试在github上发布的自述文件应该是一个简单的降价文档,即.md文件而不是原始文件.rmd.所以首先你.rmd用knitr(在R中)编织如下:

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

这将评估源中指定的全局和块选项,.rmd并生成.md相应格式化的github以及哪些github可以轻松呈现.