r - 如何从 R 包的 README.Rmd 生成 README.md？

Question

检查dplyr显示既有README.md文件又有README.Rmd文件。

在.md文件中，它说

README.md 是从 README.Rmd 生成的。请编辑该文件

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

标签： rcranroxygen2

Answer 1

只需output: github_document在顶部的 yaml 中设置，.Rmd然后单击 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)
```

然后只需单击“编织”，如下所示：

笔记：

• 对于严格为“markdown”的降价文档（与github 风格的 markdown相对），output: md_document请改用（但如果是 github 自述文件，您很可能需要 github 风格的版本）