【问题标题】:How to generate README.md from README.Rmd for R package?如何从 R 包的 README.Rmd 生成 README.md?
【发布时间】:2019-05-29 10:24:26
【问题描述】:

检查dplyr 显示同时存在README.md 文件和README.Rmd 文件。

.md 文件中,它说

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

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

【问题讨论】:

    标签: r cran roxygen2


    【解决方案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)
    ```
    

    然后像这样简单地点击“编织”:

    注意:

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

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2018-10-04
      • 2012-02-27
      • 1970-01-01
      • 2019-05-25
      • 1970-01-01
      • 2011-05-07
      • 2010-11-27
      • 1970-01-01
      相关资源
      最近更新 更多