PROSAGA码农传奇-R-如何制作出色的R可重现示例

##一个最小的可复制示例包括以下各项：

最少的数据集，是证明问题所必需的
再现错误所需的最小可运行代码，可以在给定数据集上运行
有关所用软件包，R版本和运行它的系统的必要信息。
在随机过程的情况下，set.seed()可重现性的种子（由设置）1
有关良好的最小可复制示例的示例，请参见所使用功能的帮助文件。通常，此处给出的所有代码都满足最小可重现示例的要求：提供数据，提供最少的代码，并且一切都可运行。还要查看有关堆栈溢出的问题，其中要有很多支持。

##产生最小数据集
在大多数情况下，只需提供带有某些值的向量/数据帧即可轻松完成此操作。或者，您可以使用大多数软件包随附的内置数据集之一。
可以查看内置数据集的完整列表library(help = "datasets")。每个数据集都有一个简短的描述，例如?mtcars，“ mtcars”是列表中的数据集之一，可以获得更多信息。其他软件包可能包含其他数据集。

制作矢量很容易。有时有必要在其中添加一些随机性，并且有大量的函数可以实现此目的。sample()可以将向量随机化，或者给出仅包含几个值的随机向量。letters是包含字母的有用向量。这可以用来做因素。

一些例子：

随机值：x <- rnorm(10)用于正态分布，x <- runif(10)用于均匀分布，...
一些值的排列：x <- sample(1:10)对于矢量1：10，以随机顺序排列。
随机因素： x <- sample(letters[1:4], 20, replace = TRUE)
对于矩阵，可以使用matrix()，例如：

matrix(1:10, ncol = 2)
可以使用制作数据帧data.frame()。人们应该注意命名数据框中的条目，并且不要使其过于复杂。

一个例子 ：

set.seed(1)
Data <- data.frame(
    X = sample(1:10),
    Y = sample(c("yes", "no"), 10, replace = TRUE)
)
对于某些问题，可能需要特定的格式。对于这些，可以使用任何的提供as.someType：功能as.factor，as.Date，as.xts结合的载体和/或数据帧的技巧，...这些。

##复制您的数据
如果你有一些数据，这将是太难使用这些技巧来构建，那么你可以随时让你的原始数据的一个子集，使用head()，subset()或指数。然后使用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")), .Names = c("Sepal.Length", 
"Sepal.Width", "Petal.Length", "Petal.Width", "Species"), row.names = c(NA, 
4L), class = "data.frame")
```
如果您的数据框具有多个级别的因子，则dput输出可能会很笨拙，因为即使它们在数据子集中不存在，它仍会列出所有可能的因子级别。要解决此问题，可以使用该droplevels()功能。请注意以下物种是如何仅具有一个水平的因素：
```
> dput(droplevels(iris[1:4, ]))
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 = "setosa",
class = "factor")), .Names = c("Sepal.Length", "Sepal.Width", 
"Petal.Length", "Petal.Width", "Species"), row.names = c(NA, 
4L), class = "data.frame")
```
使用时dput，您可能还希望仅包含相关列：
```
> dput(mtcars[1:3, c(2, 5, 6)]) # first three rows of columns 2, 5, and 6
structure(list(cyl = c(6, 6, 4), drat = c(3.9, 3.9, 3.85), wt = c(2.62, 
2.875, 2.32)), row.names = c("Mazda RX4", "Mazda RX4 Wag", "Datsun 710"
), class = "data.frame")
```
需要注意的另一点dput是，它不适用于键data.table对象或来自的分组tbl_df（类grouped_df）dplyr。在这些情况下，您可以在共享之前转换回常规数据帧dput(as.data.frame(my_data))。

最坏的情况是，您可以提供一个文本表示形式，可以使用text参数读取read.table：
```
zz <- "Sepal.Length Sepal.Width Petal.Length Petal.Width Species
1          5.1         3.5          1.4         0.2  setosa
2          4.9         3.0          1.4         0.2  setosa
3          4.7         3.2          1.3         0.2  setosa
4          4.6         3.1          1.5         0.2  setosa
5          5.0         3.6          1.4         0.2  setosa
6          5.4         3.9          1.7         0.4  setosa"
```
`Data <- read.table(text=zz, header = TRUE)`
##产生最少的代码
这应该是容易的部分，但通常不是。您不应该做的是：

添加所有类型的数据转换。确保提供的数据已经采用正确的格式（当然，除非有问题）
复制并粘贴提供错误的整个函数/代码块。首先，尝试找出确切导致错误的行。通常，您会发现问题出在哪里。
您应该做的是：

添加如果使用任何软件包（使用library()）应使用的软件包
如果您打开连接或创建文件，请添加一些代码以将其关闭或删除文件（使用unlink()）
如果更改选项，请确保代码包含一条语句以将其还原为原始选项。（例如op <- par(mfrow=c(1,2)) ...some code... par(op)）
在一个新的空R会话中测试您的代码，以确保该代码可运行。人们应该能够只在控制台中复制粘贴您的数据和代码，并获得与您完全相同的信息。
提供更多信息
在大多数情况下，仅R版本和操作系统就足够了。当软件包发生冲突时，提供输出sessionInfo()确实可以提供帮助。在谈论与其他应用程序的连接（通过ODBC或其他方式）时，还应提供这些应用程序的版本号，并在可能的情况下还提供有关安装程序的必要信息。

如果您在R Studio中运行R，则使用rstudioapi::versionInfo()有助于报告RStudio版本。

如果您对特定的软件包有疑问，则可能需要通过提供输出来提供该软件包的版本packageVersion("name of the package")。

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