如何简单制作自己的Rmarkdown模板

从 RStudio 菜单 File -> New File -> R Markdown 创建新的 R Markdown 文档时，你将在 RStudio 编辑器中看到默认示例文档（模板）。事实上，您可以自己创建自定义文档模板，如果您需要频繁创建特定类型的文档或想要自定义最终报告的外观，这将非常有用。¹

创建后，可以在 RStudio 中轻松访问模板，并将显示在 “New R Markdown” 窗口中。

一、安装devtools包

推荐使用devtools包来简化创建自定义 Rmarkdown 模板的过程。devtools 包提供了许多方便的函数，可以帮助你自动完成一些常见的工作，例如创建包结构、生成文档和模板等。

install.packages("devtools")

二、创建一个R项目

R Markdown 模板应包含在 R 包中，可以从 RStudio 中的菜单File -> New Project轻松创建该包（选择要为“R 包”的项目类型）。如果你已经熟悉如何创建 R 包，你当然可以自由地使用自己喜欢的方式来创建新包。

我们创建的模板应模板位于包的inst/rmarkdown/templates目录中。

在这里，可以使用devtools中的依赖包usethis中的use_rmarkdown_template()函数自动生成此结构。

usethis::use_rmarkdown_template()

可以在单个包中包含多个模板，每个模板存储在单独的子目录中。作为最小示例，inst/rmarkdown/templates/my_template需要以下文件：

template.yaml
skeleton/skeleton.Rmd

三、指定模板样式

skeleton.Rmd是一个示例 R Markdown 文档，当用户选择该模板时，这个文档将在 RStudio 中打开，为他们提供一个开始的起点。

在这个示例文档中，你可以添加一些默认内容，例如章节标题、常用包的加载以及默认的 YAML 参数设置。

---
title: "My R Markdown Template"
author: "Your Name"
date: "`r format(Sys.time(), '%Y-%m-%d')`"
output:
  bookdown::html_document2:
    theme: flatly
    toc: true
    toc_float: true
    number_sections: true
---

## Introduction

## Analysis

## Conclusions

而template.yaml则决定了 RStudio From Template 对话框中的显示方式。此 YAML 文件必须具有 name和 description 。您可以选择指定 create_dir: true 是否要在选择模板时创建新目录。

作为 template.yaml 该文件的示例：

name: My Template
description: This is my template
create_dir: false

四、安装自己的R包

最后，打包并安装自己的包

devtools::install()

此时打开File -> New File -> R Markdown 就可以看到自己的模板了

总结

通过上述步骤，你可以轻松地创建自定义 R Markdown 模板，并在 RStudio 中方便地使用它们。这使得频繁创建特定类型的文档或自定义最终报告的外观变得更加容易和高效。

---

1. 参考至17.1 模板结构 |R Markdown：权威指南 — 17.1 Template structure | R Markdown: The Definitive Guide (bookdown.org) ↩︎