如何从 README.Rmd 为 R 包生成 README.md?
How to generate README.md from README.Rmd for R package?
检查 dplyr 显示同时存在 README.md
文件和 README.Rmd
文件。
在 .md
文件中,它说
README.md is generated from README.Rmd. Please edit that file
创建.Rmd
文件很容易,但是.md
文件是如何生成的呢?它是使用 roxygen2 还是有一些终端命令(或其他命令)?
只需在 .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',如下所示:
注:
- 对于 strictly 'markdown'(相对于 github flavored markdown)的降价文档,请改用
output: md_document
(但如果它是github 自述文件,您很可能需要 github 风味版本)
检查 dplyr 显示同时存在 README.md
文件和 README.Rmd
文件。
在 .md
文件中,它说
README.md is generated from README.Rmd. Please edit that file
创建.Rmd
文件很容易,但是.md
文件是如何生成的呢?它是使用 roxygen2 还是有一些终端命令(或其他命令)?
只需在 .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',如下所示:
注:
- 对于 strictly 'markdown'(相对于 github flavored markdown)的降价文档,请改用
output: md_document
(但如果它是github 自述文件,您很可能需要 github 风味版本)