用R编写markdown格式文档

R的极客理想系列文章,涵盖了R的思想,使用,工具,创新等的一系列要点,以我个人的学习和体验去诠释R的强大。

R语言作为统计学一门语言,一直在小众领域闪耀着光芒。直到大数据的爆发,R语言变成了一门炙手可热的数据分析的利器。随着越来越多的工程背景的人的加入,R语言的社区在迅速扩大成长。现在已不仅仅是统计领域,教育,银行,电商,互联网….都在使用R语言。

要成为有理想的极客,我们不能停留在语法上,要掌握牢固的数学,概率,统计知识,同时还要有创新精神,把R语言发挥到各个领域。让我们一起动起来吧,开始R的极客理想。

关于作者:

  • 张丹,分析师/程序员/Quant: R,Java,Nodejs
  • blog: http://blog.fens.me
  • email: bsspirit@gmail.com

转载请注明出处:
http://blog.fens.me/r-markdown-rmarkdown/

前言

Markdown格式文档编写,已经从小众成为了一种主流的文档编写方式。R语言社区在可重复性文档编写领域中,有着重要的贡献。knitr和rmarkdown等包的支持,到后来在RStudio中直接集成的rmarkdown的功能,让R的广大用户有了非常舒服的markdown文档使用体验。

2015时,我就已经开始用markdown来写书稿,当时写了2篇关于在nodejs领域中使用markdown的文章,Marked高效的Markdown解析器用WebStorm编辑Markdown

时光证明了,小而美的好东西,真的会放大光芒。改变用户使用习惯,从小而美开始。

目录

  1. 创建一个rmarkdown文档
  2. 嵌入markdown文本
  3. 嵌入R代码
  4. 嵌入DT动态表格
  5. 嵌入echarts动态图
  6. 嵌入数学公式

1. 创建一个rmarkdown文档

写文档的常规操作是用word,程序员写文档的常规操作是用IDE的编程工具,用markdown格式来写文档,最后可生成word、pdf、html等文档。

我们今天讲讲怎么用R语言来写文档吧,那么R语言对markdown的支持包是rmarkdown包,现在新版的RStudio开发工具,已经集成了rmarkdown包,我们直接在RStudio中操作就行了。

首先我们先打开RStudio开发工具,选择新建一个R Markdown文件。

选择Document文档格式,设置Title, Author, Date等基本信息,然后可以选择文档输出格式HTML, PDF, Word的三种选择,不同的格式输出需求本机已经安装对应的其他软件。

打开新创建的文档,默认会是一个模板,以rmarkdown的格式进行展示,上面所输入的参数,在文档都的开头部分都有展示。然后保存一下文件。

我们可以点击Knit的下拉菜单,选择输出为HTML。

然后,运行Knit就会新打开一个窗口,看到HTML的网页输出。

如果想输出为word格式,重新选择 Knit到word就行了,运行后会弹出word的新生成的文件。

一通操作下来,功能切换很是顺畅,体验非常舒服。那么接下来就在rmarkdown中,加入各种元素,让整个文档丰富起来。

2. 嵌入markdown文本

在rmarkdown中嵌入markdown文本,是最基本的操作,在默认生成的文档中,就是一个带有markdown格式的文本。markdown格式的文本,包括10种主要的格式,分别是标题,字体,引用,分隔,图片,链接,列表,表格,代码。

2.1 标题
标题支持六级标题,用#做为开头,#的数量表示是几级标题。


# 这是一级标题
## 这是二级标题
### 这是三级标题
#### 这是四级标题
##### 这是五级标题
###### 这是六级标题


图中,左边中编辑界面,右边是HTML的输出界面。

2.2 字体
字体格式设置有2种方法,一种是就markdown默认支持的4种格式,加粗,斜体,斜体加粗,删除线。另一种方法就是使用html的标签<font>来进行设置。


**这是加粗的文字**
*这是倾斜的文字*`
***这是斜体加粗的文字***
~~这是加删除线的文字~~

<font face="宋体">宋体</font>
<font face="宋体" color="red">红色宋体</font>
<font face="宋体" color="red" size="5">5号红色宋体</font>

2.3 引用
使用>用于表示引用外部的一段话,在引用中可以用\来进行换行。


> 我要引用一段文字\
\
R语言作为统计学一门语言,一直在小众领域闪耀着光芒。直到大数据的爆发,R语言变成了一门炙手可热的数据分析的利器。随着越来越多的工程背景的人的加入,R语言的社区在迅速扩大成长。现在已不仅仅是统计领域,教育,银行,电商,互联网….都在使用R语言。

2.4 分隔

在markdown中,可以通过3个连续的-或*,来设置分隔符。


--开始

---

**开始

********************

结束

2.5 图片
插入图片时,需要使用![文本说明](链接)语法。


![R的极客理想](http://fens.me/images/slider/img4.png)


2.6 链接
设置超级链接,有2种写法,一种就是[显示文字](链接),另一种是<链接>。


[粉丝日志博客](fens.me)

<http://www.fens.me>

2.7 列表
列表支持3种语法,一种是无序列表,二是有序列表,三是嵌套列表。

  • 无序列表,用 – + * 任何一种都可以,跟内容之间都要有一个空格
  • 有序列表,用数字加点,跟内容之间都要有一个空格
  • 嵌套列表,上一级和下一级之间有三个空格,跟内容之间都要有一个空格

无序列表

+ 列表内容
+ 列表内容
+ 列表内容

有序列表

1. 列表内容
2. 列表内容
3. 列表内容

无序列表嵌套

+ 1 列表内容
   + 1.1 列表内容
   + 1.2 列表内容
+ 2 列表内容
+ 3 列表内容

2.8 表格
在嵌入表格时,需求包括表头行,分隔符行,表体行。表头行用|分隔,表体行也用|分隔,分隔符行需要用–|组合进行分隔。当希望单元格整列对齐时,可以分隔符行加:来控制对齐,文字默认居左,两边加表示文字居中,右边加:表示文字居右。


表头|表头|表头
---|:--:|---:
内容|内容|内容
内容|内容|内容

表头|表头|表头
--|--|--
内容|内容|内容
内容|内容|内容


2.9 代码
代码的嵌入可以分为行内代码嵌入代码和代码块。

  • 行内代码,需要使用”包住代码,代码不可换行。
  • 代码块,需要用“` “`来包住代码,代码可换行。

文字中内嵌了`a="abc"`代码

```
a="abc"
a1=2
a2=3
a3=a1+a2
```

Markdown的基本语法,就是这9部分很简单,写一次练习一下,就记住了。

3. 嵌入R代码

上面我们演示了在markdown中嵌入代码,那么对于R语言来说,如果我们希望嵌入R代码,需要代码块针对R代码做一些支持的时候,要怎么写呢。


```{r}
a<-Sys.Date()
a

head(iris)
plot(iris)
```

接下来,我们还可以在{r echo=FALSE}加入echo=FALSE,这样就不输出R的代码本身了。


```{r echo=FALSE}
library(xts)
xdf<-xts(rnorm(100),order.by = as.Date('2022-01-01')+1:100)
plot(xdf)
```

4. 嵌入DT动态表格

在R的代码中,我们可以调用R的各种包进行输出,可以使用DT包来做动态表格,只要把数据放到datatable()函数中,就可以在markdown中生成对应的动态表格,支持翻页、关键字搜索,排序等多种功能。


```{r}
library(DT)
datatable(iris)
```

5. 嵌入echarts动态图

在文档输出时,经常需要用图进行展示,我们也可以直接使用echart4r包来调用echarts进行多种图的可视化展示。


```{r}
library(echarts4r)
library(magrittr)
iris %>% 
  e_charts(x = Sepal.Length) %>%
  e_scatter(serie = Sepal.Width )
```

6. 嵌入数学公式

文档中,也避免不了经常会写一些数据公式 ,rmarkdown中也集成是嵌入数据公式的功能。我们可以直接使用$$公式$$的语法,来生成复杂的数学公式。在文档中加入数学公式,是使用mathjax格式来进行数学公式的编辑。


$$
\hat\beta_1=\frac{\sum\left(X_i-\overline{X}\right)Y_i}{\sum\left(X_i-\overline{X}\right)^2}=\frac{\sum X_iY_i-\overline{X}\sum Y_i}{\sum X_i^2+\sum \overline{X}^2 - 2\overline{X}\sum X_i}\\
=\frac{\sum X_iY_i-\overline{X}*N\overline{Y}}{\sum X_i^2+N\overline{X}^2 - 2\overline{X}*N\overline{X}}
=\frac{\sum^{N}_{i=1} X_iY_i-N\overline{XY}}{\sum^{N}_{i=1}Xi^2-N\overline{X}^2}
$$

本文我介绍了rmarkdown的功能,有非常丰富的支持,多样的表达形式,语法简单,而且是可重复性生成的,比起 word 写文档,有更多的编程的特点。写书,写论文,写标书,写文档,都是不错的选择。

转载请注明出处:
http://blog.fens.me/r-markdown-rmarkdown/

打赏作者

This entry was posted in R语言实践