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

use*_*745 4 r cran roxygen2

检查dplyr显示有一个README.md文件和一个README.Rmd文件。

在.md文件中,它说

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

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

use*_*745 6

只需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)
```
Run Code Online (Sandbox Code Playgroud)

然后只需像这样单击“编织”:

在此处输入图片说明

笔记:

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