在与同事讨论绩效、教学、发送错误报告或搜索邮件列表和Stack Overflow上的指导时，经常会询问一个可重复的示例，并且总是很有用。
你有什么建议来创建一个优秀的例子？如何以文本格式粘贴r中的数据结构？您还应包括哪些其他信息？
除了使用dput（）、dump（）或structure（）之外，还有其他技巧吗？什么时候应该包含library（）或require（）语句？除了c、df、data等之外，应该避免哪些保留字。？
如何做出一个伟大的、可重复的例子？
当前回答
请不要像这样粘贴控制台输出：
If I have a matrix x as follows:
> x <- matrix(1:8, nrow=4, ncol=2,
dimnames=list(c("A","B","C","D"), c("x","y")))
> x
x y
A 1 5
B 2 6
C 3 7
D 4 8
>
How can I turn it into a dataframe with 8 rows, and three
columns named `row`, `col`, and `value`, which have the
dimension names as the values of `row` and `col`, like this:
> x.df
row col value
1 A x 1
...
(To which the answer might be:
> x.df <- reshape(data.frame(row=rownames(x), x), direction="long",
+ varying=list(colnames(x)), times=colnames(x),
+ v.names="value", timevar="col", idvar="row")
)
我们不能直接复制粘贴它。
要使问题和答案正确再现，请在发布前删除+&>，并在输出和评论中添加#，如下所示：
#If I have a matrix x as follows:
x <- matrix(1:8, nrow=4, ncol=2,
dimnames=list(c("A","B","C","D"), c("x","y")))
x
# x y
#A 1 5
#B 2 6
#C 3 7
#D 4 8
# How can I turn it into a dataframe with 8 rows, and three
# columns named `row`, `col`, and `value`, which have the
# dimension names as the values of `row` and `col`, like this:
#x.df
# row col value
#1 A x 1
#...
#To which the answer might be:
x.df <- reshape(data.frame(row=rownames(x), x), direction="long",
varying=list(colnames(x)), times=colnames(x),
v.names="value", timevar="col", idvar="row")
还有一件事，如果您使用了某个包中的任何函数，请提及该库。
其他回答
R-help邮件列表有一个发布指南，包括提问和回答问题，包括生成数据的示例：
示例：有时提供一个小例子实际上可以运行。例如：如果我有如下矩阵x：
> x <- matrix(1:8, nrow=4, ncol=2,
dimnames=list(c("A","B","C","D"), c("x","y"))
> x
x y
A 1 5
B 2 6
C 3 7
D 4 8
>
如何将其转换为数据帧具有8行和3列“row”、“col”和“value”，它们具有维度名称为“row”和“col”的值，如下所示：
> x.df
row col value
1 A x 1
...（答案可能是：
> x.df <- reshape(data.frame(row=rownames(x), x), direction="long",
varying=list(colnames(x)), times=colnames(x),
v.names="value", timevar="col", idvar="row")
)
“小”这个词特别重要。您应该以最小的可重复示例为目标，这意味着数据和代码应该尽可能简单地解释问题。
编辑：漂亮的代码比难看的代码更容易阅读。使用样式指南。
我正在开发wakefield包，以解决快速共享可复制数据的需求，有时dput对较小的数据集很好，但我们处理的许多问题要大得多，通过dput共享如此大的数据集是不切实际的。
关于：
wakefield允许用户共享最少的代码来再现数据。用户设置n（行数）并指定任意数量的预设变量函数（目前有70个），这些函数模拟真实的if数据（如性别、年龄、收入等）
安装：
目前（2015年6月11日），wakefield是一个GitHub包，但在编写单元测试后，最终将转到CRAN。要快速安装，请使用：
if (!require("pacman")) install.packages("pacman")
pacman::p_load_gh("trinker/wakefield")
例子：
下面是一个示例：
r_data_frame(
n = 500,
id,
race,
age,
sex,
hour,
iq,
height,
died
)
这将产生：
ID Race Age Sex Hour IQ Height Died
1 001 White 33 Male 00:00:00 104 74 TRUE
2 002 White 24 Male 00:00:00 78 69 FALSE
3 003 Asian 34 Female 00:00:00 113 66 TRUE
4 004 White 22 Male 00:00:00 124 73 TRUE
5 005 White 25 Female 00:00:00 95 72 TRUE
6 006 White 26 Female 00:00:00 104 69 TRUE
7 007 Black 30 Female 00:00:00 111 71 FALSE
8 008 Black 29 Female 00:00:00 100 64 TRUE
9 009 Asian 25 Male 00:30:00 106 70 FALSE
10 010 White 27 Male 00:30:00 121 68 FALSE
.. ... ... ... ... ... ... ... ...
请不要像这样粘贴控制台输出：
If I have a matrix x as follows:
> x <- matrix(1:8, nrow=4, ncol=2,
dimnames=list(c("A","B","C","D"), c("x","y")))
> x
x y
A 1 5
B 2 6
C 3 7
D 4 8
>
How can I turn it into a dataframe with 8 rows, and three
columns named `row`, `col`, and `value`, which have the
dimension names as the values of `row` and `col`, like this:
> x.df
row col value
1 A x 1
...
(To which the answer might be:
> x.df <- reshape(data.frame(row=rownames(x), x), direction="long",
+ varying=list(colnames(x)), times=colnames(x),
+ v.names="value", timevar="col", idvar="row")
)
我们不能直接复制粘贴它。
要使问题和答案正确再现，请在发布前删除+&>，并在输出和评论中添加#，如下所示：
#If I have a matrix x as follows:
x <- matrix(1:8, nrow=4, ncol=2,
dimnames=list(c("A","B","C","D"), c("x","y")))
x
# x y
#A 1 5
#B 2 6
#C 3 7
#D 4 8
# How can I turn it into a dataframe with 8 rows, and three
# columns named `row`, `col`, and `value`, which have the
# dimension names as the values of `row` and `col`, like this:
#x.df
# row col value
#1 A x 1
#...
#To which the answer might be:
x.df <- reshape(data.frame(row=rownames(x), x), direction="long",
varying=list(colnames(x)), times=colnames(x),
v.names="value", timevar="col", idvar="row")
还有一件事，如果您使用了某个包中的任何函数，请提及该库。
基本上，一个最小的可重复示例（MRE）应该能够让其他人在他们的机器上准确地再现您的问题。
请不要发布数据、代码或控制台输出的图像！
tl；博士
MRE包括以下项目：
演示问题所需的最小数据集再现问题所需的最小可运行代码，可在给定数据集上运行有关所用库、R版本和运行该库的操作系统的所有必要信息，可能是sessionInfo（）在随机进程的情况下，一个种子（set by set.seed（））使其他人能够复制与您完全相同的结果
有关良好MRE的示例，请参阅帮助页底部有关您正在使用的函数的“示例”部分。只需键入例如help（mean）或short？意味着进入你的R控制台。
提供最小数据集
通常，共享巨大的数据集是不必要的，而且可能会阻碍其他人阅读您的问题。因此，最好使用内置数据集或创建一个类似于原始数据的小“玩具”示例，这实际上是指最小值。如果出于某种原因，您确实需要共享原始数据，那么您应该使用一种方法，例如dput（），允许其他人获得数据的精确副本。
内置数据集
您可以使用内置数据集之一。使用data（）可以看到内置数据集的全面列表。每个数据集都有简短的描述，可以获得更多信息，例如：？虹膜，用于R附带的“虹膜”数据集。安装的软件包可能包含其他数据集。
创建示例数据集
初步说明：有时您可能需要特殊格式（例如类），例如因子、日期或时间序列。对于这些，请使用以下函数：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分布的密度（即x点处曲线的高度）的R函数，您可能会与它发生冲突。
复制原始数据
如果您有特定的原因，或者数据很难从中构建示例，那么可以提供原始数据的一小部分，最好使用dput。
为什么使用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
子集数据
要共享子集，请使用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（下降等级（虹膜[1:4，]））。dput的另一个警告是，它不适用于键控data.table对象或来自tidyverse的分组tbl_df（class grouped_df）。在这些情况下，您可以在共享之前转换回常规数据帧dput（如.data.frame（my_data））。
生成最小代码
结合最少的数据（见上文），您的代码应该通过简单的复制和粘贴在另一台机器上准确地再现问题。
这应该是容易的部分，但往往不是。您不应该做的事情：
示出了各种数据转换；确保提供的数据已经是正确的格式（当然，除非这是问题所在）复制粘贴在某个地方出现错误的整个脚本。尝试找出导致错误的确切行。通常情况下，你会发现问题出在自己身上。
您应该做什么：
如果使用任何包，请添加使用的包（使用library（））在新的R会话中测试运行代码，以确保代码可运行。人们应该能够在控制台中复制粘贴您的数据和代码，并获得与您相同的效果。如果打开连接或创建文件，请添加一些代码以关闭连接或删除文件（使用unlink（））如果更改选项，请确保代码中包含一条语句，以将其还原为原始选项。（例如op<-par（mfrow=c（1,2））。。。一些代码。。。par（操作））
提供必要信息
在大多数情况下，只有R版本和操作系统就足够了。当包发生冲突时，提供sessionInfo（）的输出确实会有所帮助。当谈到与其他应用程序的连接（无论是通过ODBC还是其他任何方式）时，还应提供这些应用程序的版本号，如果可能，还应包括有关设置的必要信息。
如果您在R Studio中运行R，使用rstudioapi:：versionInfo（）可以帮助报告您的RStudio版本。
如果您对特定的包有问题，您可能希望通过提供packageVersion（“包的名称”）的输出来提供包版本。
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和以前的版本之间，set.seed（）的输出不同。指定您在随机过程中使用的R版本，如果您在回答旧问题时得到的结果略有不同，请不要感到惊讶。为了在这种情况下获得相同的结果，可以在set.seed（）之前使用RNGversion（）-函数（例如：RNGversion“3.5.2”）。
如果您的数据中有一个或多个因子变量，您希望使用dput（head（mydata））进行复制，请考虑向其添加droplevel，以便最小化数据集中不存在的因子级别不包含在dput输出中，以使示例最小化：
dput(droplevels(head(mydata)))
