Mar*_*ite 5 r devtools roxygen2
我目前正在为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
Run Code Online (Sandbox Code Playgroud)
.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
Run Code Online (Sandbox Code Playgroud)
我想运行的代码是(注意:我没有library在实际函数中调用,为简单起见,我只是在这里做):
library(dplyr)
valid_values <- ref %>%
select(z) %>%
unname() %>%
unlist() %>%
as.character()
summary <- user %>%
mutate(x_valid=ifelse(x %in% valid_values, TRUE, FALSE))
Run Code Online (Sandbox Code Playgroud)
summary告诉我xin user中哪些值有效:
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
Run Code Online (Sandbox Code Playgroud)
现在,我该用什么替换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))
)
}
Run Code Online (Sandbox Code Playgroud)
我该???用什么代替来获取数据?我不太在乎用户是否能够看到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
Run Code Online (Sandbox Code Playgroud)
我想出来了,以防万一将来有人遇到这个。我是如何做到这一点的,只是从/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))
)
}
Run Code Online (Sandbox Code Playgroud)