如何从R包的README.Rmd文件生成README.md文件？

Question

查看 dplyr 代码库可以发现，既有一个 README.md 文件，也有一个 README.Rmd 文件。

.md 文件中写道：

  

README.md 是由 README.Rmd 自动生成的。请编辑那个文件。

创建 .Rmd 文件很容易，但是如何生成 .md 文件呢？使用 roxygen2 还是一些终端命令（或其他方法）？

- stevec

Answer 1

只需在 .Rmd 顶部的yaml中设置output: github_document，然后点击knit即可。

这是一个小而完整的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)
```

然后只需像这样点击“knit”：

注意：

• 对于严格的“Markdown”文档（而不是GitHub风格的Markdown），请改用output: md_document（但如果是用于GitHub自述文件，您很可能需要使用GitHub风格的版本）

- stevec

---

只是为了提供一个非RStudio的替代方案，可以使用devtools::build_readme()。但是，正如上面的答案提到的，你必须包含output: github_document，否则输出将是html格式。 - undefined