Question

我目前正在撰写R package hosted on GitHub的文档。我使用knitr和R Markdown来编写README文件。点击“针织HTML”＆＃39; RStudio中的按钮产生一个像我期望的那样的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。所以首先用编织器（在R中）编织.rmd，如下所示：

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

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

Answer 2

有关使用.Rmd生成.md的更多信息，请参阅http://r-pkgs.had.co.nz/release.html的Readme.Rmd部分

您还可以使用devtools::use_readme_rmd()自动为您的包设置devtools。

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

2 个答案: