rmarkdown
rmarkdown包帮助您创建动态分析文档,结合代码、渲染输出(如图表)和文本。您提供数据、代码和想法,R Markdown将您的内容渲染成精美的文档,可用于:
- 在RStudio IDE中进行交互式数据科学分析,
- 复现您的分析,
- 与他人协作和共享代码,以及
- 向他人传达您的结果。
R Markdown文档可以渲染为多种输出格式,包括HTML文档、PDF、Word文件、幻灯片等,让您专注于内容,而R Markdown负责处理展示。
书籍
在入门指南中了解更多信息。
安装
安装rmarkdown包最简单的方法是在RStudio IDE中进行,但您不需要显式安装或加载它,因为RStudio在需要时会自动完成这两项操作。还需要较新版本的Pandoc(>= 1.12.3);如果您计划在RStudio IDE中使用rmarkdown,RStudio也会自动包含Pandoc,所以您不需要下载Pandoc。
如果您想在RStudio之外使用rmarkdown包,可以从CRAN安装:
install.packages("rmarkdown")
如果您想使用rmarkdown包的开发版本(无论是否使用RStudio),可以通过remotes包从GitHub安装:
# install.packages("pak")
pak::pak('rstudio/rmarkdown')
如果不使用RStudio IDE,您需要安装较新版本的Pandoc(>= 1.12.3);请参阅Pandoc安装说明获取帮助。
使用方法
创建新的R Markdown文档最简单的方法是在RStudio中进行。转到"文件 > 新建文件 > R Markdown"。在新建文件向导中,您可以:
- 提供文档标题(可选但建议)
- 提供作者姓名(可选但建议)
- 选择默认输出格式 - 推荐HTML格式用于编写,您可以随时切换输出格式(必选)
- 点击"确定"(必选)
在新的.Rmd
文件中,您会看到一些包含代码块的样板文本。使用RStudio IDE中的"Knit"按钮一键渲染文件并预览输出,或使用键盘快捷键Cmd/Ctrl + Shift + K。
您也可以删除YAML前置元数据下的所有文本,填写自己的.Rmd
内容:
- 添加代码块(键盘快捷键:
Ctrl + Alt + I
;OS X:Cmd + Option + I
) - 使用Markdown格式编写文本
- 通过点击RStudio中的图标交互式运行每个代码块
您还可以再次点击"Knit to HTML"来渲染包含所有代码块的完整文档。要获取R Markdown入门的更多帮助,请访问R Markdown网站或使用本页顶部的"入门"链接。
获取帮助
有两个主要的获取帮助的地方:
-
Posit社区是询问有关rmarkdown和R Markdown系列包的任何问题的友好场所。
-
Stack Overflow是获取常见rmarkdown问题答案的绝佳来源。一旦您创建了一个说明问题的可复现示例,它也是获得帮助的好地方。
行为准则
请注意,rmarkdown项目发布时附带贡献者行为准则。通过为该项目做出贡献,您同意遵守其条款。