如何在 R 包中的函数中使用数据？

Question

我目前正在为 R 包编写函数。此功能的部分目的是 (a) 将数据作为输入，以及 (b) 根据可接受值列表检查其中一列。

这些可接受的值是另一个组织提供给我的。它们位于 .csv 文件中。我想要做的是加载此 .csv 文件并将其用作参考以检查用户的列是否具有有效值。

例如，假设用户有这些数据：

set.seed(1839)
user <- data.frame(x=sample(letters,10),
                   y=rnorm(10))
user

   x          y
1  v -0.7025836
2  p -1.4586245
3  f  0.1987113
4  y  1.0544690
5  o -0.7112214
6  m  0.2956671
7  b  0.3016737
8  a -0.0945271
9  x -0.2790357
10 c  0.1681388

并且 .csv 包含许多（有用的）列，但我目前只关心一个 (z)：

ref <- data.frame(z=letters[1:4], a=rnorm(4), b=(rnorm(4)))
ref

  z          a          b
1 a -0.3563105  1.4536406
2 b  1.6841862  1.3232985
3 c  1.3073516 -0.6978598
4 d  0.4352904 -0.3971175

我想运行的代码是（注意：我没有在实际函数中调用 library，我只是为了简单起见在这里这样做）：

library(dplyr)
valid_values <- ref %>%
  select(z) %>% 
  unname() %>% 
  unlist() %>% 
  as.character()

summary <- user %>% 
  mutate(x_valid=ifelse(x %in% valid_values, TRUE, FALSE))

summary 告诉我 user 中 x 的哪些值是有效的：

   x          y x_valid
1  v -0.7025836   FALSE
2  p -1.4586245   FALSE
3  f  0.1987113   FALSE
4  y  1.0544690   FALSE
5  o -0.7112214   FALSE
6  m  0.2956671   FALSE
7  b  0.3016737    TRUE
8  a -0.0945271    TRUE
9  x -0.2790357   FALSE
10 c  0.1681388    TRUE

现在，我用什么来替换我的函数代码中的 ref？我应该将这些数据存储在包中的什么位置？我该如何加载它？我应该将其转换成什么类型的文件？

函数应该类似于：

x_check <- function(data) {

  # get valid values
  valid_values <- ??? %>%
    select(z) %>% 
    unname() %>% 
    unlist() %>% 
    as.character()

  # compare against valid values
  return(
    data %>% 
    mutate(x_valid=ifelse(x %in% valid_values, TRUE, FALSE))
  )
}

我应该用什么替换 ??? 来获取我的数据？我不太关心用户是否能够看到我希望加载的 ref 数据。

我正在使用 devtools::load_all("directory/for/my/package") 来测试我的包。相关会话信息：

R version 3.4.0 (2017-04-21)
Platform: x86_64-redhat-linux-gnu (64-bit)
Running under: Red Hat Enterprise Linux Server 7.3 (Maipo)

other attached packages:
[1] roxygen2_6.0.1             devtools_1.13.2

Answer 1

我想出来了，以防万一以后有人遇到这个问题。我是如何做到这一点的，只是在函数内的本地环境中从 /data 文件加载数据：

x_check <- function(data) {

  # get reference data
  data("ref", envir=environment())

  # get valid values
  valid_values <- ref %>%
    select(z) %>% 
    unname() %>% 
    unlist() %>% 
    as.character()

  # compare against valid values
  return(
    data %>% 
    mutate(x_valid=ifelse(x %in% valid_values, TRUE, FALSE))
  )
}

Answer 2

请参阅 Hadley Wickham 关于 R 编写程序包的书，他在其中解释了 how to store data in a package。

"The most common location for package data is (surprise!) data/. Each file in this directory should be a .RData file created by save() containing a single object (with the same name as the file)."

这将使您的包的任何用户都可以访问您的数据集 packagename::data。

如何在 R 包中的函数中使用数据？

How to use data within a function in an R package?

r

devtools

roxygen2