【2.1.3】bookdown

更多阅读:

R bookdown 是什么

  1. 一个用来写书写文章的软件。
  2. 比Word更美观,比LaTeX更易用,比Markdown格式更丰富。
  3. 可以方便地插入目录、图表、交叉引用、脚注、索引。
  4. 可以方便地插入公式、参考文献、R代码。
  5. 可以生成漂亮的pdf、word和网页文件。
  6. 撰写可重复性报告的不二之选。

PS: 页眉页脚呢?

安装

  1. 下载R并安装。
  2. 下载RStudio并安装。
  3. Windows下载CTEX并安装。建议安装完整版。 下载地址:http://www.ctex.org/CTeXDownload

  4. 下载Pandoc并安装。

  5. 运行RStudio。在左上面板的代码窗口输入并运行以下代码(安装bookdown扩展包):

  6. install.packages(“bookdown”) 好了,安装完毕。

从模板开始

下载模板文档(到下载页面点击Clone or download – Download ZIP): 如果你要写英文文档,那么下载通用模板; https://github.com/rstudio/bookdown-demo 如果你要写中文文档,那么下载中文模板。 https://github.com/yihui/bookdown-chinese 将模板文档解压缩到任意文件夹。

在解压缩后得到的文件里找到扩展名为.Rproj的文件。双击,默认会用RSudio打开。

在RStudio右上面板点击Build标签,再点击build book。好了,模板书出现在名为_book的子文件夹里。

在RStudio右下面板里会看到该文件夹里的文件,其中有一些扩展名为.Rmd的文件。逐个点击打开,把其中的内容修改成你自己的内容。除了index.Rm外,不需要的.Rmd文件可以删掉。

重复第4步,就得到了你自己的书。

对照一下.Rmd的文件内容和生成的文档,体会两者之间是如何对应的。

基本标记

### 标记  输出
*斜体*    斜体
**粗体**   粗体
CO~2~   CO2下标
R^2^    R2上标
$E = mc^2$  E=mc2E=mc2 行内公式(双美元符号为行间公式)
[大鹏志](http://dapengde.com)  大鹏志超级链接
<dapengde@live.com> dapengde@live.com 邮件链接
![](http图片链接)   插入图片
> 引用文字  引用
`代码`    代码
# 第一章   章节标题
1. 首先,...   带编号的列表
- 首先    不带编号的列表
^[脚注]   脚注

章节划分、编号和交叉引用

# (PART) Part I {-} 
# (APPENDIX) Appendix {-} 
# References {-}
# chapter {#ID}
## section {#ID}
# chapter {#ID .unnumbered}
\@ref(ID)

图表

第一种插图:嵌入的R代码作图:

```{r, fig.cap='caption', out.width='80%', fig.align='center', echo=FALSE}
plot(1:10)
```

\@ref(fig:fig1)

第二种插图:将现成的图片文件插进来:

```{r img1, fig.cap='caption', out.width='80%', fig.align='center', echo=FALSE}
knitr::include_graphics("images/img1.png")
```

\@ref(fig:img1)

第三种插图:用markdown基础语法:

!(images/img1.png)

第一种表格:直接用markdown语法画表格。输入:

第一列标题  第二列标题
----------- ----------
第一行1     第一行2
第二行1     第二行2

输出:

第一列标题 第二列标题 第一行1 第一行2 第二行1 第二行2

第二种表格:用R函数展示表格:

```{r tab1, tidy=FALSE, echo=FALSE}
knitr::kable(
  head(iris, 20), caption = 'Here is a nice table!',
  booktabs = TRUE
)
```

\@ref(tab:tab1)

参考文献

参考文献信息需要保存在.bib文件里。

引用文献条目:[@R-bookdown]

参考文献列表:# References {-}

生成R包参考文献库:

knitr::write_bib(c("knitr", "stringr"), "", width = 60)

定义、定理、示例等环境

环境全称:theorems   lemma   definition  corollary   proposition example
引用简称:thm          lem   def         cor         prp         ex


```{环境全称, label='', name=""}
内容
```

\@ref(引用简称:label)

输出word文档

在_output.yml里添加一行: bookdown::word_document2: default

注意,default这个词是不能少的。

导出的word文档相当令人满意,参考文献的版式、图表的交叉引用都堪称完美。唯一不足之处,是公式的编号和交叉引用。bookdown的官方文档5给出的公式书写方案是,利用 LATEXLATEX 的公式环境来编号和引用,这一点在生成pdf时没问题,但生成word时,会发现别说编号,连公式本身都消失了。这大概是因为pandoc未能将公式环境正确转换的缘故。解决办法是,不使用公式环境,而使用行内公式(即公式前后有一个美元符号),公式前面用圆括号里加公式标签就可以了。例如,输入:

(@eq-mc) $E = mc^2$

I like Eq. (@eq-mc) so much that I am falling love with her.

得到:

1. E=mc2E=mc2
I like Eq. (1) so much that I am falling love with her.

公式编号和引用

word文档里的公式的编号和交叉引用,可以使用行内公式,公式前用圆括号里加公式标签。例如,输入: (@eq-mc) $E = mc^2$

I like Eq. (@eq-mc) so much that I am falling love with her.

得到: E=mc2

I like Eq. (1) so much that I am falling love with her.

pdf文档里的公式编号和交叉引用,建议使用公式环境。例如,输入:

\begin{equation} 
E = mc^2
  (\#eq:mc2)
\end{equation} 

I like Eq. \@ref(eq:mc2) so much that I am falling love with her.

中文支持

bookdown默认是按章节标题来生成网页文件名称,纯英文标题和纯中文标题都没问题,但对中英混合的标题,bookdown会只取其中的英文部分为html文件命名。如果每个章节标题里都有个R字母,那么生成的html文件就都叫R.html,编译时就会报错。解决办法是给heading添加{#ID},让编译生成的html文件以此ID命名。解决是解决了,但又出现无编号章节标题{#ID} 和{-}共存问题。这就不知道怎么搜了,只好继续骚扰益辉,得到的答案是 {#identifier .unnumbered}

报错:

Quitting from lines 20-28 (bookdown.Rmd) Error in contrib.url(repos, type) : trying to use CRAN without setting a mirror Calls: … lapply -> FUN -> install.packages -> grep -> contrib.url

解决办法:

install.packages(“weatherData”,repos = “http://cran.us.r-project.org")

参考资料:

http://dapengde.com/archives/19141

http://dapengde.com/archives/19122

https://bookdown.org/yihui/bookdown

个人公众号,比较懒,很少更新,可以在上面提问题,如果回复不及时,可发邮件给我: tiehan@sina.cn

Sam avatar
About Sam
专注生物信息 专注转化医学