如何从R包的README.Rmd生成README.md?

时间:2019-05-29 10:24:26

标签: r cran roxygen2

检查dplyr会同时显示一个README.md文件和一个README.Rmd文件。

.md文件中,

  

README.md由README.Rmd生成。请修改该文件

创建.Rmd文件很容易,但是如何生成.md文件呢?是使用roxygen2还是有一些终端命令(或其他命令)?

1 个答案:

答案 0 :(得分:2)

只需在output: github_document顶部的Yaml中设置.Rmd,然后单击编织即可。

这里有一个小而完整的RMarkdown文档作为示例:

---
output: github_document
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```

## R Markdown

This is an R Markdown document that generates a github readme.md file.

```{r}
summary(iris)
```

然后只需单击“编织”,如下所示:

enter image description here

注意:

  • 对于严格标记为'markdown'的markdown文档(与github flavored markdown相对),请使用output: md_document(但是如果是github自述文件,则将可能想要github风格的版本)