reprex

概述

准备可在GitHub问题、StackOverflow、Slack消息或代码片段中发布的reprex，甚至可以粘贴到PowerPoint或Keynote幻灯片中。什么是reprex？它是可重现的示例（reproducible example）的缩写，这个词由Romain Francois在2014年的一条推文中首次提出。

给定剪贴板上的R代码、在RStudio中选择的代码、表达式（引用或未引用）或文件中的代码...

通过rmarkdown::render()运行它，
对render()参数、knitr选项和Pandoc选项进行精心选择。

获得可运行的代码+输出结果，格式为：

Markdown，适用于GitHub、Stack Overflow或Slack，或
R代码，附带注释形式的输出，或
纯HTML或（实验性）富文本

结果会以不可见的方式返回，写入文件，并在可能的情况下放置到剪贴板上。在RStudio查看器或默认浏览器中预览HTML版本。

安装

从CRAN安装：

install.packages("reprex")

或从GitHub获取开发版本：

# install.packages("pak")
pak::pak("tidyverse/reprex")

在Linux上，你可能需要安装xclip或xsel，以便reprex能访问X11剪贴板。这是"锦上添花"的功能，非必需。对于xclip和xsel，通常可以使用sudo apt-get install或sudo yum install安装方法。

使用方法

假设你将以下代码复制到剪贴板（或在RStudio Server或Cloud上选中它）：

(y <- 1:4)
mean(y)

然后调用reprex()，默认目标平台是GitHub：

reprex()

一个格式良好的HTML预览将在RStudio的查看器中显示（如果你使用RStudio），或在你的默认浏览器中显示。

GitHub风格的Markdown相关部分已准备就绪，可以从剪贴板粘贴（在RStudio Server或Cloud上，你需要自己复制）：

``` r
(y <- 1:4)
#> [1] 1 2 3 4
mean(y)
#> [1] 2.5
```

以下是该Markdown在GitHub问题中渲染后的样子：

(y <- 1:4)
#> [1] 1 2 3 4
mean(y)
#> [1] 2.5

其他人可以立即复制、粘贴并运行这段代码。

除了GitHub，这种Markdown格式也适用于Stack Overflow和Discourse。可以通过venue = "so"和venue = "ds"正式指定这些平台，但它们实际上只是venue = "gh"的别名。

除了从剪贴板读取，你还可以：

使用reprex(mean(rnorm(10)))从表达式获取代码。
reprex(input = "mean(rnorm(10))\n")从字符向量获取代码（通过长度或结尾换行符检测）。输入源中的前导提示符会被去除：reprex(input = "> median(1:3)\n")产生的输出与reprex(input = "median(1:3)\n")相同。
reprex(input = "my_reprex.R")从文件获取代码。
使用RStudio的某个插件来使用选中的文本或当前文件。

但是，还有更多功能！

使用reprex(..., venue = "slack")获取为Slack消息优化的略有不同的Markdown。
使用reprex(..., venue = "R")获取一个可运行的R脚本，其中包含注释形式的输出。这对Slack代码片段、电子邮件等很有用。
使用reprex(..., venue = "html")获取html。适用于不支持Markdown的网站。
使用 reprex(..., venue = "rtf") 准备（未）渲染的、带有语法高亮的代码片段，以粘贴到Keynote或PowerPoint中。此功能仍处于实验阶段；更多详情请参阅相关文章。
默认情况下，图片会上传到 imgur.com，生成的URL会被插入到内联图片标签中。
如果您确实需要在特定目录中执行reprex，请使用 wd 参数。例如，reprex(wd = ".") 请求使用当前工作目录。
通过 reprex(..., session_info = TRUE) 附加会话信息。
使用以下方法从野生捕获的reprex中获取干净、可运行的代码：
- reprex_invert() = reprex() 的反向操作
- reprex_clean()，例如当您从GitHub或Stack Overflow复制/粘贴时
- reprex_rescue()，当您处理从R控制台复制/粘贴的内容时