mirror of
https://github.com/LCTT/TranslateProject.git
synced 2025-01-13 22:30:37 +08:00
410 lines
11 KiB
Markdown
410 lines
11 KiB
Markdown
|
[#]: subject: "Beginner's Guide to R Markdown Syntax [With Cheat Sheet]"
|
|||
|
[#]: via: "https://itsfoss.com/r-markdown/"
|
|||
|
[#]: author: "Sreenath https://itsfoss.com/author/sreenath/"
|
|||
|
[#]: collector: "lkxed"
|
|||
|
[#]: translator: "lxbwolf"
|
|||
|
[#]: reviewer: " "
|
|||
|
[#]: publisher: " "
|
|||
|
[#]: url: " "
|
|||
|
|
|||
|
R Markdown 语法新手指南[备忘录]
|
|||
|
======
|
|||
|
|
|||
|
你可能已经了解过轻量级标记语言 Markdown。如果你是第一次接触这个概念,请参考我们的 [Markdown 指南][1]。概括来讲,它是一种用于创建纯文本文档的简单又高效的语言。
|
|||
|
|
|||
|
然而,Markdown 在制作详细的报告或技术文件方面可能还不够完善。
|
|||
|
|
|||
|
受益于[knitr][2]和[Pandoc][3]等软件包,**交互式文件格式 R Markdown** 早在 2014 年就出现了。它将纯文本与内嵌的 R 代码相结合,可以制作动态文件。
|
|||
|
|
|||
|
你可以使用 [各种 IDE][4] 和扩展来创建 R Markdown 文档,官方 IDE 为**RStudio**。因此,在这篇文章中,我们将重点介绍**使用 RStudio 学习 R Markdown语法**。
|
|||
|
|
|||
|
💡
|
|||
|
|
|||
|
(假如你没有了解过,)**R 编程语言** 是一种用于统计计算、图形表示和报告的语言。
|
|||
|
|
|||
|
**推荐阅读 📖**
|
|||
|
|
|||
|
是一种用于统计计算、图形表示和报告的语言。
|
|||
|
|
|||
|
**建议阅读 📖**
|
|||
|
|
|||
|
如何在 Ubuntu 上安装和使用 R。
|
|||
|
概要:本教程教你如何在 Ubuntu上安装 R。你还将学习在 Ubuntu 上运行你的第一个 R 程序的各种方法。R 和 Python 都是最常用的统计计算和图形的编程语言,能让数据处理变得简单。
|
|||
|
![][5]
|
|||
|
![][6]
|
|||
|
|
|||
|
### 配置 RStudio
|
|||
|
|
|||
|
通过合适的配置,你可以很轻松地用 RStudio 来编写 R Markdown。当你安装完一个软件包后,就已经完成了大部分的工作!
|
|||
|
|
|||
|
安装 RStudio 后,在**工具**菜单中选择_安装软件包_选项。
|
|||
|
|
|||
|
![在 RStudio 的工具菜单下选择安装软件包选项][7] 。
|
|||
|
|
|||
|
在弹出的对话框中,搜索 rmarkdown 并安装。
|
|||
|
|
|||
|
![通过搜索并在新的软件包安装对话框中按下安装按钮来安装 Rmarkdown 软件包][8]
|
|||
|
|
|||
|
💡
|
|||
|
|
|||
|
如果你想使用类似 python 的代码块,你需要安装额外的包。当你想在你的文档中包含这些包时,RStudio 会提示你安装所需的包。
|
|||
|
|
|||
|
安装完成后,你可以通过选择**文件>新建>RMarkdown** 来新建一个 rmarkdown 文档。
|
|||
|
|
|||
|
![从文件菜单中创建一个新的 RMarkdown 文档][9] 。
|
|||
|
|
|||
|
之后会提示你添加一些关于文件的信息(文件的元数据),把这些填上就可以了。
|
|||
|
|
|||
|
![用 rmarkdown 语法写出标题和其他细节][10]
|
|||
|
|
|||
|
或者你可以创建一个空的文件从零开始。
|
|||
|
|
|||
|
### RMarkdown 语法
|
|||
|
|
|||
|
由于它是"加强版的 Markdown",因此大多数语法与 markdown 是一样的。
|
|||
|
|
|||
|
它还有一些 Markdown 支持不完善的东西,比如**表格、数学方程式、代码块等等**。
|
|||
|
|
|||
|
下面是我们要介绍的内容的概括。
|
|||
|
|
|||
|
<table>
|
|||
|
<thead>
|
|||
|
<tr>
|
|||
|
<th>RMarkdown 块名</th>
|
|||
|
<th>语法</th>
|
|||
|
</tr>
|
|||
|
</thead>
|
|||
|
<tbody>
|
|||
|
<tr>
|
|||
|
<td>标题</td>
|
|||
|
<td># 一级标题<br>## 二级标题<br>### 三级标题<br><br>一级标题<br>=======<br><br>二级标题<br>-------</td>
|
|||
|
</tr>
|
|||
|
<tr>
|
|||
|
<td>着重</td>
|
|||
|
<td>*斜体*<br>_斜体_<br><br>**加粗**<br><br>__加粗__</td>
|
|||
|
</tr>
|
|||
|
<tr>
|
|||
|
<td>列表</td>
|
|||
|
<td>无序列表<br>* 列表项<br>* 列表项<br> + 子项<br> + 子项<br><br>有序列表<br>1. 列表项<br>2. 列表项<br> + 子项<br> + 子项</td>
|
|||
|
</tr>
|
|||
|
<tr>
|
|||
|
<td>代码块</td>
|
|||
|
<td>普通代码块<br><br>```<br>这里写代码<br>```<br><br>R 代码块<br><br>```{r}<br>R 代码<br>```<br>你也可以用其他的语言<br><br><br>行内 `代码`</td>
|
|||
|
</tr>
|
|||
|
<tr>
|
|||
|
<td>链接</td>
|
|||
|
<td>纯文本:粘贴 URL<br>带标题的链接:[显示的文本](URL_地址)<br>跳转到锚点[显示的文本](#锚点)</td>
|
|||
|
</tr>
|
|||
|
<tr>
|
|||
|
<td>表格</td>
|
|||
|
<td>| 列名 | 列名 | 列名 |<br>| ------ | ------ | ------ |<br>| 项内容 | 项内容 | 项内容 |<br>| 项内容 | 项内容 | 项内容 |</td>
|
|||
|
</tr>
|
|||
|
<tr>
|
|||
|
<td>方程式</td>
|
|||
|
<td>行内方程式 \$Equations\$<br><br>展示方程式: \$\$Equations\$\$</td>
|
|||
|
</tr>
|
|||
|
<tr>
|
|||
|
<td>图片</td>
|
|||
|
<td>无标题: ![](图片链接)<br><br>有标题: ![可选标题](图片地址)</td>
|
|||
|
</tr>
|
|||
|
<tr>
|
|||
|
<td>引用块</td>
|
|||
|
<td>> 输入你引用的内容</td>
|
|||
|
</tr>
|
|||
|
<tr>
|
|||
|
<td>其他</td>
|
|||
|
<td>上角标:文本内容^上角标^<br><br>章或页水平分割线<br><br>========= 或 ----------<br><br>行尾输入两个以上空格,即可添加人工行分割</td>
|
|||
|
</tr>
|
|||
|
</tbody>
|
|||
|
</table>
|
|||
|
|
|||
|
#### YAML 头
|
|||
|
|
|||
|
在一个 R Markdown 文档的顶部,有一个 YAML 头,被两行 `------` 包围。这个块定义了文档的最终样式,通常包含一个标题、作者、日期和你想输出的文件类型。
|
|||
|
|
|||
|
支持的文件格式有三种:**HTML、PDF 和 Word**。
|
|||
|
|
|||
|
```
|
|||
|
---
|
|||
|
title: "Sample"
|
|||
|
author: "It's FOSS"
|
|||
|
date: "2023-02-08"
|
|||
|
output: pdf_document
|
|||
|
---
|
|||
|
```
|
|||
|
|
|||
|
这可以在 RStudio 中设置新文件时添加,如上节所示。
|
|||
|
|
|||
|
#### 标题
|
|||
|
|
|||
|
在 R Markdown 中,有两种方法指定标题。我们可以使用 `#` 字符来表示不同级别的标题,比如:
|
|||
|
|
|||
|
```
|
|||
|
# Heading Level 1
|
|||
|
## Heading Level 2
|
|||
|
### Heading Level 3
|
|||
|
#### Heading Level 4
|
|||
|
##### Heading Level 5
|
|||
|
###### Heading Level 6
|
|||
|
```
|
|||
|
|
|||
|
也可以用 `=` 和 `-` 分别表示一级和二级标题。
|
|||
|
|
|||
|
```
|
|||
|
一级标题
|
|||
|
===============
|
|||
|
|
|||
|
二级标题
|
|||
|
---------------
|
|||
|
```
|
|||
|
|
|||
|
![rmarkdown 文件中不同等级的标题][11]
|
|||
|
|
|||
|
#### 列表
|
|||
|
|
|||
|
有两种列表,一种是**无序列表**,用点句符来表示:
|
|||
|
|
|||
|
```
|
|||
|
* Item 1
|
|||
|
* Item 2
|
|||
|
+ Sub 1
|
|||
|
+ Sub 2
|
|||
|
* Item 3
|
|||
|
```
|
|||
|
|
|||
|
另一种是**有序列表**,用数字来排序:
|
|||
|
|
|||
|
```
|
|||
|
1. Item 1
|
|||
|
2. Item 2
|
|||
|
+ Sub 1
|
|||
|
+ Sub 2
|
|||
|
3. Item 3
|
|||
|
```
|
|||
|
|
|||
|
![有序和无序列表示例][12]
|
|||
|
|
|||
|
**推荐阅读 📖**
|
|||
|
|
|||
|
在 Linux 终端用 Glow 阅读和组织 Markdown 文件。Glow 是一个 CLI 工具,能在 Linux 终端渲染 Markdown 文件。你还可以用它来组织 Markdown 文件。
|
|||
|
![][13]
|
|||
|
![][14]
|
|||
|
|
|||
|
#### 段落中的文本格式
|
|||
|
|
|||
|
格式化文本有几种方式。
|
|||
|
|
|||
|
![][15]
|
|||
|
|
|||
|
你可以使用斜体或加粗来着重表示文本:
|
|||
|
|
|||
|
- 斜体:在文本前后各输入一个星号或下划线
|
|||
|
- 加粗:在文本前后各输入两个星号或下划线
|
|||
|
|
|||
|
```
|
|||
|
*这里是斜体内容*
|
|||
|
_这里是斜体内容_
|
|||
|
|
|||
|
**这里是加粗内容**
|
|||
|
__这里是加粗内容__
|
|||
|
```
|
|||
|
|
|||
|
你可以阅读我们的文章 [Markdown 中怎么让内容变成加粗和斜体][16] 来了解更多内容.
|
|||
|
|
|||
|
如果你想使用上角标,在想变成上角标的内容前后加上 `^` 符号。
|
|||
|
|
|||
|
```
|
|||
|
普通文本内容^上角标^
|
|||
|
```
|
|||
|
|
|||
|
如果你想对文本内容加删除线,在文本前后加 `~~` 符号。
|
|||
|
|
|||
|
```
|
|||
|
~~被删除的内容~~
|
|||
|
```
|
|||
|
|
|||
|
![][17]
|
|||
|
|
|||
|
#### 添加代码块
|
|||
|
|
|||
|
内嵌代码 是 R Markdown 最主要的设计目的。我们有几种添加代码的方式。
|
|||
|
|
|||
|
**添加普通代码块**
|
|||
|
|
|||
|
如果你想添加一个代码块来与其他的文本进行区分,可以使用下面的语法:
|
|||
|
|
|||
|
````
|
|||
|
```
|
|||
|
这里输入你的代码
|
|||
|
```
|
|||
|
````
|
|||
|
|
|||
|
|
|||
|
你也可以尝试 [对添加的代码进行高亮显示][18].
|
|||
|
|
|||
|
如果你想添加代码并将其输出嵌入到文档中,你可以在后面加上语言,并用大括号包裹:
|
|||
|
|
|||
|
|
|||
|
```{语言}
|
|||
|
这里输入你的代码
|
|||
|
```
|
|||
|
|
|||
|
|
|||
|
你可以用 ` 符号来添加行内代码。
|
|||
|
|
|||
|
```
|
|||
|
这里是 `行内代码`
|
|||
|
```
|
|||
|
|
|||
|
它看起来是这样的:
|
|||
|
|
|||
|
![][19]
|
|||
|
|
|||
|
#### 链接
|
|||
|
|
|||
|
如果想添加普通文本链接,把它粘贴到行内就可以了。
|
|||
|
|
|||
|
```
|
|||
|
https://itsfoss.com
|
|||
|
```
|
|||
|
|
|||
|
添加超链接,使用下面的语法:
|
|||
|
|
|||
|
```
|
|||
|
[文本内容](URL 地址)
|
|||
|
```
|
|||
|
|
|||
|
当你想链接到本页内的某个锚点时,使用下面的语法:
|
|||
|
```
|
|||
|
[文本内容](#锚点名称)
|
|||
|
```
|
|||
|
|
|||
|
![][20]
|
|||
|
|
|||
|
#### 表格
|
|||
|
|
|||
|
表格的语法与 markdown 相似:
|
|||
|
|
|||
|
```
|
|||
|
|列表|列表|列表|
|
|||
|
| --- | --- | --- |
|
|||
|
|表格项|表格项|表格项|
|
|||
|
|表格项|表格项|表格项|
|
|||
|
```
|
|||
|
|
|||
|
![][21]
|
|||
|
|
|||
|
📋
|
|||
|
|
|||
|
还想了解更多?请阅读我们的 [用 Markdown 创建表格][22] 指南。
|
|||
|
|
|||
|
.
|
|||
|
|
|||
|
#### 图片
|
|||
|
|
|||
|
添加图片使用下面的语法:
|
|||
|
|
|||
|
```
|
|||
|
![](http://example.com/logo.png)
|
|||
|
|
|||
|
或
|
|||
|
|
|||
|
![可选显示文本](figures/img.png)
|
|||
|
```
|
|||
|
|
|||
|
![][23]
|
|||
|
|
|||
|
#### 块引用
|
|||
|
|
|||
|
RMarkdown 可以添加块引用。在被引用的行或段落前添加 **>(大于号)**。
|
|||
|
|
|||
|
```
|
|||
|
这里是普通文本内容。
|
|||
|
|
|||
|
> 这里是块引用
|
|||
|
```
|
|||
|
|
|||
|
![][24]
|
|||
|
|
|||
|
如果你想了解更多块引用的内容,请阅读我们的 [Markdown 引用][25] 指南。
|
|||
|
|
|||
|
#### 方程式
|
|||
|
|
|||
|
你可以用 RMarkdown 来添加方程式和展示复杂的 LaTex 方程式。
|
|||
|
|
|||
|
例如:
|
|||
|
|
|||
|
```
|
|||
|
行内毕达哥拉斯定理: $Equation$
|
|||
|
|
|||
|
展示方程式:$$Equation$$
|
|||
|
```
|
|||
|
|
|||
|
![在 R Markdown 文档中添加方程式][26]
|
|||
|
|
|||
|
#### 章或页水平分割线
|
|||
|
|
|||
|
使用三个以上星号或减号来添加章或页水平分割线。
|
|||
|
|
|||
|
```
|
|||
|
************
|
|||
|
|
|||
|
------------
|
|||
|
```
|
|||
|
|
|||
|
你可以在行尾添加两个以上的空格来添加人工行分割。
|
|||
|
|
|||
|
### 总结
|
|||
|
|
|||
|
### R Markdown 非常有用(备忘录)
|
|||
|
|
|||
|
|
|||
|
|
|||
|
![][27]
|
|||
|
|
|||
|
[R Markdown 备忘录.pdf 下载文档][28]
|
|||
|
|
|||
|
_💬 你还知道其他关于 R Markdown 的内容吗?请在下面的评论区告诉我们。_
|
|||
|
|
|||
|
--------------------------------------------------------------------------------
|
|||
|
|
|||
|
via: https://itsfoss.com/r-markdown/
|
|||
|
|
|||
|
作者:[Sreenath][a]
|
|||
|
选题:[lkxed][b]
|
|||
|
译者:[lxbwolf](https://github.com/lxbwolf)
|
|||
|
校对:[校对者ID](https://github.com/校对者ID)
|
|||
|
|
|||
|
本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译,[Linux中国](https://linux.cn/) 荣誉推出
|
|||
|
|
|||
|
[a]: https://itsfoss.com/author/sreenath/
|
|||
|
[b]: https://github.com/lkxed/
|
|||
|
[1]: https://itsfoss.com/markdown-guide/
|
|||
|
[2]: https://www.r-project.org/nosvn/pandoc/knitr.html
|
|||
|
[3]: https://itsfoss.comknitr, and Pandoc
|
|||
|
[4]: https://itsfoss.com/best-modern-open-source-code-editors-for-linux/
|
|||
|
[5]: https://itsfoss.com/content/images/size/w256h256/2022/12/android-chrome-192x192.png
|
|||
|
[6]: https://itsfoss.com/content/images/wordpress/2019/06/install-r-on-ubuntu.jpg
|
|||
|
[7]: https://itsfoss.com/content/images/2023/02/select-install-packages.png
|
|||
|
[8]: https://itsfoss.com/content/images/2023/02/install-rmarkdown-1.png
|
|||
|
[9]: https://itsfoss.com/content/images/2023/02/new-r-markdown.png
|
|||
|
[10]: https://itsfoss.com/content/images/2023/02/new-document-in-rmark.png
|
|||
|
[11]: https://itsfoss.com/content/images/2023/02/Headings.png
|
|||
|
[12]: https://itsfoss.com/content/images/2023/02/List.png
|
|||
|
[13]: https://itsfoss.com/content/images/size/w256h256/2022/12/android-chrome-192x192.png
|
|||
|
[14]: https://itsfoss.com/content/images/wordpress/2022/01/glow-cli-markdown.png
|
|||
|
[15]: https://itsfoss.com/content/images/2023/02/emphasis.png
|
|||
|
[16]: https://itsfoss.com/markdown-bold-italic/
|
|||
|
[17]: https://itsfoss.com/content/images/2023/02/superescript.png
|
|||
|
[18]: https://itsfoss.com/markdown-code-block/
|
|||
|
[19]: https://itsfoss.com/content/images/2023/02/code-chunk.png
|
|||
|
[20]: https://itsfoss.com/content/images/2023/02/links.png
|
|||
|
[21]: https://itsfoss.com/content/images/2023/02/table.png
|
|||
|
[22]: https://itsfoss.com/markdown-table/
|
|||
|
[23]: https://itsfoss.com/content/images/2023/02/images.png
|
|||
|
[24]: https://itsfoss.com/content/images/2023/02/block-quotes.png
|
|||
|
[25]: https://itsfoss.com/markdown-quotes/
|
|||
|
[26]: https://itsfoss.com/content/images/2023/02/equations.png
|
|||
|
[27]: https://itsfoss.com/content/images/2023/02/R-Markdown-Cheat-Sheet.webp
|
|||
|
[28]: https://itsfoss.com/content/files/2023/02/R-Markdown-Cheat-Sheet.pdf
|