如何解决如何制作一个出色的 R 可重现示例

基本上，一个应该能够让其他人在他们的机器上准确地重现您的问题。

MRE 由以下项目组成：

一个，是证明问题所必需的
重现错误所需的
有关使用的软件包、R 版本和运行它的操作系统的所有
在随机过程的情况下，可重复性的（由设置）set.seed()

有关良好 MRE 的示例，请参阅您正在使用的函数的帮助文件底部的“示例”部分。只需在 R 控制台中输入 eghelp(mean)或 short即可。?mean

提供最小数据集

通常，不需要共享庞大的数据集，而且可能会阻止其他人阅读您的问题。因此，最好使用内置数据集或创建一个类似于您的原始数据的小型“玩具”示例，这实际上是最小的意思。如果出于某种原因您确实需要共享您的原始数据，您应该使用一种方法，例如dput()，允许其他人获取您的数据的精确副本。

内置数据集

您可以使用其中一种内置数据集。可以使用来查看内置数据集的完整列表data()。每个数据集都有一个简短的描述，并且可以获得更多信息，例如使用?irisR 附带的“iris”数据集。安装的包可能包含其他数据集。

创建示例数据集

初步说明：有时您可能需要特殊格式（即类），例如因子、日期或时间序列。对于这些，请使用以下功能：as.factor, as.Date, as.xts, …示例：

d <- as.Date("2020-12-30")

在哪里

class(d)
# [1] "Date"

x <- rnorm(10)  ## random vector normal distributed
x <- runif(10)  ## random vector uniformly distributed    
x <- sample(1:100, 10)  ## 10 random draws out of 1, 2, ..., 100    
x <- sample(LETTERS, 10)  ## 10 random draws out of built-in latin alphabet

m <- matrix(1:12, 3, 4, dimnames=list(LETTERS[1:3], LETTERS[1:4]))
m
#   A B C  D
# A 1 4 7 10
# B 2 5 8 11
# C 3 6 9 12

set.seed(42)  ## for sake of reproducibility
n <- 6
dat <- data.frame(id=1:n, 
                  date=seq.Date(as.Date("2020-12-26"), as.Date("2020-12-31"), "day"),
                  group=rep(LETTERS[1:2], n/2),
                  age=sample(18:30, n, replace=TRUE),
                  type=factor(paste("type", 1:n)),
                  x=rnorm(n))
dat
#   id       date group age   type         x
# 1  1 2020-12-26     A  27 type 1 0.0356312
# 2  2 2020-12-27     B  19 type 2 1.3149588
# 3  3 2020-12-28     A  20 type 3 0.9781675
# 4  4 2020-12-29     B  26 type 4 0.8817912
# 5  5 2020-12-30     A  26 type 5 0.4822047
# 6  6 2020-12-31     B  28 type 6 0.9657529

虽然它被广泛使用，但最好不要命名您的数据框df，因为df()它是 F 分布的密度（即曲线在点的高度）的 R 函数，x您可能会与它发生冲突。

复制原始数据

如果您有特定原因，或者数据很难从中构建示例，您可以提供原始数据的一小部分，最好使用dput.

dput抛出在控制台上准确再现数据所需的所有信息。您可以简单地复制输出并将其粘贴到您的问题中。

如果您在问题中共享，调用dat（从上面）产生的输出仍然缺少有关变量类和其他功能的信息。此外，列中的空格type使得它很难做任何事情。即使我们开始使用这些数据，我们也无法正确获取您数据的重要特征。

  id       date group age   type         x
1  1 2020-12-26     A  27 type 1 0.0356312
2  2 2020-12-27     B  19 type 2 1.3149588
3  3 2020-12-28     A  20 type 3 0.9781675

Tho 共享子集、使用head()或subset()索引iris[1:4, ]。然后把它包装进去dput()，给别人一些可以立即放入 R 的东西。例子

dput(iris[1:4, ]) # first four rows of the iris data set

要在您的问题中分享的控制台输出：

structure(list(Sepal.Length = c(5.1, 4.9, 4.7, 4.6), Sepal.Width = c(3.5, 
3, 3.2, 3.1), Petal.Length = c(1.4, 1.4, 1.3, 1.5), Petal.Width = c(0.2, 
0.2, 0.2, 0.2), Species = structure(c(1L, 1L, 1L, 1L), .Label = c("setosa", 
"versicolor", "virginica"), class = "factor")), row.names = c(NA, 
4L), class = "data.frame")

使用时dput，您可能还希望仅包含相关列，例如 dput(mtcars[1:3, c(2, 5, 6)])

如果您的数据框有一个包含多个级别的因子，则dput输出可能会很笨拙，因为它仍会列出所有可能的因子级别，即使它们不存在于您的数据子集中。要解决此问题，您可以使用该droplevels()功能。请注意下面的物种是如何只有一个水平的因素，例如dput(droplevels(iris[1:4, ]))。另一个需要注意的是，dput它不适用于键控data.table对象tbl_df或grouped_df. tidyverse在这些情况下，您可以在共享之前转换回常规数据框，dput(as.data.frame(my_data)).

生成最少的代码

结合最少的数据（见上文），您的代码应该通过简单地复制和粘贴来准确地在另一台机器上重现问题。

这应该是容易的部分，但通常不是。你不应该做的事情：

显示各种数据转换；确保提供的数据已经采用正确的格式（当然，除非这是问题所在）
复制粘贴在某处出现错误的整个脚本。尝试找出导致错误的确切行。很多时候，你会发现问题出在自己身上。

你应该做什么：

如果您使用任何软件包，请添加您使用的软件包（使用library()）
test 在新的 R 会话中运行您的代码，以确保代码可运行。人们应该能够在控制台中复制粘贴您的数据和代码并获得与您相同的内容。
如果您打开连接或创建文件，请添加一些代码以关闭它们或删除文件（使用unlink()）
如果您更改选项，请确保代码包含将它们恢复为原始选项的语句。（例如op <- par(mfrow=c(1,2)) ...some code... par(op)）

提供必要的信息

在大多数情况下，只需 R 版本和操作系统就足够了。当与包发生冲突时，提供的输出sessionInfo()真的很有帮助。在谈论与其他应用程序的连接（通过 ODBC 或其他任何方式）时，还应提供这些应用程序的版本号，如果可能，还应提供有关设置的必要信息。

如果您在R Studio中运行 R ，使用rstudioapi::versionInfo()可以帮助报告您的 RStudio 版本。

如果您对特定包有问题，您可能希望通过提供packageVersion("name of the package").

Seed

使用set.seed()您可以指定seed1，即特定状态，R 的随机数生成器是固定的。这使得随机函数（例如sample()、和许多其他函数rnorm()）runif()始终返回相同的结果成为可能，例如：

set.seed(42)
rnorm(3)
# [1]  1.3709584 -0.5646982  0.3631284

set.seed(42)
rnorm(3)
# [1]  1.3709584 -0.5646982  0.3631284

1 R >3.6.0 和以前的版本之间的输出不同。指定您用于随机过程的 R 版本，如果您在回答旧问题时得到的结果略有不同，请不要感到惊讶。要在这种情况下获得相同的结果，您可以在之前使用 -function （例如：）。 set.seed()``RNGversion()``set.seed()``RNGversion("3.5.2")

解决方法

你对创建一个优秀的例子有什么建议？你如何粘贴数据结构r以文本格式？您还应该包括哪些其他信息？

除了使用dput(),dump()还有其他技巧structure()吗？什么时候应该包含library()orrequire()语句？除了c,df,data等之外，还应该避免哪些保留字？

如何制作一个出色的 R 可重现示例