Task0.1 R Markdown 和 R Notebook
摘要:
- R Markdown在生成PDF(Word, HTML)文件后会直接显示代码段的运行结果(值或图像)
- R Notebook能够在HTML文件中选择是否显示代码运行得到的结果(值或图像)
在写作业的时候遇到了这两类文件,不太清楚其区别,在网络上找到了一些资料,于是在这里总结一下。
参考
[1] Rmarkdown与Rnotebook使用心得_zorchp的博客-CSDN博客_markdown notebook
[2] R-Markdown学习与使用 - 简书 (jianshu.com)
[3] R数据科学
[4] Rstudio.com
[5] Rmarkdown导出中文PDF解决方案 - 灰信网(软件开发博客聚合) (freesion.com)
[6] rticles/skeleton.Rmd at main · rstudio/rticles · GitHub
[7] R Markdown: The Definitive Guide (bookdown.org)
1 R Markdown简介
1.1 基本结构
(1) 两个---之间的(可选) YAML(yet another markup language)渲染参数,通常用于控制输出细节。
(2) Markdown标记&文本:采样Markdown语法。
(3) 两个```之间的R语言代码块:选择Insert插入代码块,可以设置代码块的标题,以及是否显示warning信息等参数。
1.2 运行
打开一个.Rmd文件后,就会进人笔记本界面,其中代码和代码结果可以交互显示。通过点击Run图标(位于代码段上方,类似播放按钮)或按组合键Ctrl+Shift+Enter,就可以运行每个代码段。RStudio可以运行代码,并将运行结果显示在代码下面。
如果想要生成包含所有文本、代码和输出的完整报告,可以点击Knit或按组合键Ctrl+Shift+K。还可以使用代码rmarkdown::render("1-example.Rmd")在程序中完成这个操作。报告会显示在查看器窗格中,并生成可以与他人分享的一个独立的HTML文件。
在生成文档时,R Markdown先将.Rmd文件发送给knitr,knitr会执行所有代码段,并创建一个新的Markdown文件(.md),其中包含所有代码和输出。然后knitr生成的Markdown文件再由pandoc进行处理,并生成最终文件。这种两阶段工作流的优点是可以创建多种输出格式。
1.3 基本语法
1.3.1 YAML
常见的两种YAML文件头包括:文档参数和参考文献,可以在齿轮图标中进行设置。最常见的参数包括
- title :文档标题
- author :作者
- date :日期
- output :输出格式
- params :参数域
(1) 常见的output包括:
- html_document :输出html格式
- pdf_document :输出PDF格式
- word_document :输出word格式
每种格式又有很多参数,比如toc:yes/no表示是否设置目录。
如果需要在PDF中显示中文还要加上:documentclass: ctexart,并修改字体引擎为 xelatex:latex_engine: xelatex
这里不一一列举。
(2) params:R Markdown文件中可以包含在生成报告时进行设置的一个或多个参数。如果想要重新生成报告,但对多个关键输入使用与原来不同的值,那么这些参数就非常有用了。
(3) 参考文献与引用
占个坑,休息一下再学
1.3.2 Markdown
(1) 语法
R Markdown的语法与Markdown的基本一致,核心区别在于R Markdown写入代码区域的代码能在编译的时候同时生成相应的图、表和运算结果,省去了保存和插入的过程。同时能保存为 HTML、 WORD和PDF等格式,但PDF需要LaTex的支持。
具体语法可以参考[2] R-Markdown学习与使用 - 简书 (jianshu.com)
(2) 如何在R Markdown中输出中文PDF?
可以参考
[5] Rmarkdown导出中文PDF解决方案 - 灰信网(软件开发博客聚合) (freesion.com)
[6] rticles/skeleton.Rmd at main · rstudio/rticles · GitHub
其中:
- documentclass: ctexart 调用的是Ctex,不用更改
- output:
- rticles::ctex:
- fig_caption: yes #表示图上的注释保留
- number_sections: yes # 表示每一节的数字保留
- classoption: “hyperref,” # 允许超链接
1.3.3 代码段
我们可以赋予代码段一个可选的名称,使得通过目录更方便浏览特定的代码段。此外setup这个代码段名称具有特殊意义。当处于笔记本模式时,名称为setup的代码段会在任何其他代码运行前自动运行一次。(notebook?)
以下是最重要的一组选项,用来控制代码段是否可以执行,以及最终报告中包括哪些结果。
2 R Notebook简介
R Notebook(扩展名.Rmd)类似于Python的Jupyter Notebook,或者MATLAB中的notebook文件(在新版本中已经删去了notebook文件,转而以功能更为强大的实时脚本文件mix文件代替),都是可以交互执行代码块的文件格式,其语法也沿用了Markdown的语法,所以写起来很顺手。美中不足的一点是R Notebook文件只能在IDE中运行代码,生成的Html文件只能作静态的代码展示(不过可以选择是否展开代码块)。
[7] 3.2 Notebook | R Markdown: The Definitive Guide (bookdown.org)