我目前正在为GitHub上托管的R包编写文档。我knitr
与R Markdown一起使用来编写自述文件。在RStudio中点击“编织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处理它的方式)?
您尝试在github上发布的自述文件应该是普通的markdown文档,即.md
文件,而不是raw文件.rmd
。因此,首先.rmd
要用knitr(在R内)编织,如下所示:
knit(input="readme.rmd", output = "readme.md") #see ?knit for more options
这将评估源中指定的全局和块选项,.rmd
并产生.md
相应格式的github可以轻松呈现的格式。
本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句