rmdformats, RMarkdown文档的HTML输出格式

分享于 

6分钟阅读

GitHub

  繁體 雙語
HTML output formats for RMarkdown documents
  • 源代码名称:rmdformats
  • 源代码网址:http://www.github.com/juba/rmdformats
  • rmdformats源代码文档
  • rmdformats源代码下载
  • Git URL:
    git://www.github.com/juba/rmdformats.git
    Git Clone代码到本地:
    git clone http://www.github.com/juba/rmdformats
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/juba/rmdformats
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
    rmdformats

    Travis-CI Build StatusCRAN_Status_BadgeCRAN Downloads

    这个 R 包为RMarkdown文档提供了 ready-to-use HTML输出格式和模板。 它的目标是生成干净的文档"走出盒子",带有或者没有 RStudio IDE。

    格式库

    软件包提供了几种HTML输出格式。 你可以单击图像来查看真实的HTML输出示例。

    material 格式

    Bootstrap 3 材质设计主题所采用的格式。 文档分为每个 <h1> header的页面,内容的table 允许在这些页面之间进行动画导航。

    readthedown 格式

    根据相应的readtheorg 主题,适应 org-html-themes项目,充分响应动态内容的内容和可以折叠的导航功能。

    html_clean 格式

    table Hester软件包的动态,非常简洁的模板,非常类似于来自伟大 knitrBootstrap包的一个。

    html_docco 格式

    简单模板,无 table 内容。 CSS从默认的 docco项目中激发了大量的灵感。

    特性和帮助器

    根据以下格式,有些额外功能可用:

    • readthedown 完全响应,具有可折叠的导航功能
    • html_cleanreadthedown 提供了自动和动态的内容 table
    • html_cleanhtml_docco 为带有lightbox显示的图形提供自动缩略图
    • 代码折叠和tabsets在rstudio模板的HTML中支持

    包还提供了一个 create.doc() 函数和RStudio文档模板,以便轻松生成一个空的,准备使用多个配置指令的rmarkdown文件。

    最后,它还提供了 pilltabs() helper 函数,该函数允许动态显示交叉表。 请参见中的一个输出示例示例。

    安装

    你可以从CRAN安装最新的稳定发行版:

    install.packages("rmdformats")

    或者来自GitHub的最新开发快照:

    install.packages(devtools) # if necessarydevtools::install_github("juba/rmdformats")

    创建新文档

    RStudio中的

    选择 File> New File...> R Markdown...,然后选择 From Template。 然后,你就可以从一个软件包模板中创建一个新文档。

    没有RStudio的

    使用 create.doc() 函数,你可以创建一个带有干净 ready-to-use RMarkdown文件的新目录。 create.doc() 获得两个主要参数:

    • dirname 是要创建的文件夹和RMarkdown文件的NAME
    • format 是 NAME 格式( "html_clean" 或者 "html_docco" )

    默认情况下,将在新文件夹中创建 Makefile 文件,以便从 命令行 直接呈现。

    渲染

    带RStudio的

    从RStudio中进行渲染应该非常简单: 只需单击 Knit 按钮。

    来自 R的

    你可以从 rmarkdown 包中的render() 函数直接将文档从 R 转换为 HTML:

    library(rmarkdown)
    render("mydocument.Rmd")

    使用生成文件生成

    如果使用 create.doc() 函数创建 .Rmd 文件,则可以使用以下方法生成HTML或者PDF文件:

    
    make html
    
    
    make pdf
    
    
    
    

    你还可以清除任何生成的文件并使用以下方法缓存:

     
    make clean
    
    
    
     

    Credits

    html_clean 风格和特性非常类似于来自great的伟大 knitrBootstrap包,by。


    for  DOC  form  格式  OUT  输出  
    相关文章