reprex

reprex

R语言包快速生成可复现代码

reprex是一个R语言包,用于快速创建可复现的代码示例。该工具支持从剪贴板、文件或直接输入获取代码,并生成GitHub风格的Markdown、R代码或HTML输出。reprex具备图片上传和会话信息添加功能,适用于GitHub、Stack Overflow等多种分享场景,方便开发者展示代码和寻求技术支持。

reprex可复现示例R语言MarkdownGitHubGithub开源项目

reprex <a href="https://reprex.tidyverse.org"><img src="https://yellow-cdn.veclightyear.com/0a4dffa0/d44e7647-657b-407c-b890-034c5aed2f69.png" align="right" height="138" alt = ""/></a>

<!-- badges: start -->

CRAN_Status_Badge R-CMD-check Codecov test coverage

<!-- badges: end -->

概述

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

<a href="https://media.giphy.com/media/fdLR6LGwAiVNhGQNvf/giphy.gif"><img src="https://yellow-cdn.veclightyear.com/0a4dffa0/99d41422-a5c0-4e18-8e6e-a07870827af2.png" align="right" /></a>

给定剪贴板上的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上,你可能需要安装xclipxsel,以便reprex能访问X11剪贴板。这是"锦上添花"的功能,非必需。对于xclip和xsel,通常可以使用sudo apt-get installsudo 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控制台复制/粘贴的内容时

编辑推荐精选

iTerms

iTerms

企业专属的AI法律顾问

iTerms是法大大集团旗下法律子品牌,基于最先进的大语言模型(LLM)、专业的法律知识库和强大的智能体架构,帮助企业扫清合规障碍,筑牢风控防线,成为您企业专属的AI法律顾问。

SimilarWeb流量提升

SimilarWeb流量提升

稳定高效的流量提升解决方案,助力品牌曝光

稳定高效的流量提升解决方案,助力品牌曝光

Sora2视频免费生成

Sora2视频免费生成

最新版Sora2模型免费使用,一键生成无水印视频

最新版Sora2模型免费使用,一键生成无水印视频

Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
商汤小浣熊

商汤小浣熊

最强AI数据分析助手

小浣熊家族Raccoon,您的AI智能助手,致力于通过先进的人工智能技术,为用户提供高效、便捷的智能服务。无论是日常咨询还是专业问题解答,小浣熊都能以快速、准确的响应满足您的需求,让您的生活更加智能便捷。

imini AI

imini AI

像人一样思考的AI智能体

imini 是一款超级AI智能体,能根据人类指令,自主思考、自主完成、并且交付结果的AI智能体。

Keevx

Keevx

AI数字人视频创作平台

Keevx 一款开箱即用的AI数字人视频创作平台,广泛适用于电商广告、企业培训与社媒宣传,让全球企业与个人创作者无需拍摄剪辑,就能快速生成多语言、高质量的专业视频。

即梦AI

即梦AI

一站式AI创作平台

提供 AI 驱动的图片、视频生成及数字人等功能,助力创意创作

下拉加载更多