【问题标题】:Load r package in selected environment在选定的环境中加载 r 包
【发布时间】:2016-07-03 02:29:16
【问题描述】:

我是 R 包开发和堆栈溢出的新手,但我无法在任何地方找到此信息。

我正在尝试加载 R 包鼠标,而不会污染我的命名空间。我试过只导入我正在使用的函数,但没有奏效。所以我会满足于在一个特定的环境中加载整个包,如下所示:

e <- new.env()
load_package_into_environment(e, package = "mice")
eval(mice(data, m = m, maxit = max.iter, printFlag = F), envir = e)

但是,我无法找到替换“load_package_into_environment”占位符的实际功能。什么功能(如果有的话)可以实现这一点?

编辑:以下是我正在使用的文件以及我必须提供更多详细信息的问题。

文件:描述

Package: bug.example2
Title: Example of Package Loading Bug
Version: 0.0.0.9000
Authors@R: person("R", "Woodbridge", email = "example@gmail.com", role = c("aut", "cre"))
Description: Creates a wrapper function for mice::mice function.
Depends:
    R (>= 3.2.3),
    data.table (>= 1.9.6)
License:
LazyData: true
Imports: mice
RoxygenNote: 5.0.1

文件:NAMSPACE(由 roxygen 自动生成)

import(data.table)
importFrom(mice,mice)
importFrom(mice,mice.impute.logreg)
importFrom(mice,mice.impute.pmm)
importFrom(mice,mice.impute.polr)
importFrom(mice,mice.impute.polyreg)

文件:impute.R(使用mice包中的mice函数)

#' @import data.table
#' @importFrom mice mice
#' @importFrom mice mice.impute.pmm
#' @importFrom mice mice.impute.logreg
#' @importFrom mice mice.impute.polyreg
#' @importFrom mice mice.impute.polr
#' @export
impute <- function(data, m = 5, max.iter = 5){

mice_environment <- new.env()


#Impute missing data using mice function, output format is mids object
mice.out <- mice(data, m = m, maxit = max.iter, printFlag = F)

#save the m imputed data.frames as a list of data.tables
return.list <- lapply(1:m, function(x){
                                    as.data.table(complete(mice.out, x))
                                      })
names(return.list) <- paste0("imp.",1:m)
return.list
}

文件:test-impute.R(使用 testthat 包来测试 impute 函数)

context("Impute missing values")
test_that("Output format is a list of lenght m and each element is a data.table",{
#Set up data
set.seed(200)
data <- iris
data$Species[runif(nrow(data)) < .1] <- NA
data$Sepal.Width[runif(nrow(data)) < .2] <- NA
setDT(data)

#Create imputed data
M <- 5
impute.output <- impute(data, m = M)

#Test output format
expect_is(impute.output, "list")
expect_equal(length(impute.output), M)
lapply(impute.output,expect_is, "data.table")
})

testthat 的错误输出

1. Error: Output format is a list of lenght m and each element is a data.table -
The following functions were not found: mice.impute.pmm, mice.impute.polyreg
1: withCallingHandlers(eval(code, new_test_environment), error = capture_calls, message = function(c) invokeRestart("muffleMessage"))
2: eval(code, new_test_environment)
3: eval(expr, envir, enclos)
4: impute(data, m = M) at test-impute.R:12
5: mice(data, m = m, maxit = max.iter, printFlag = F) at          C:\repos\bug.example2/R/impute.R:11
6: check.method(setup, data)
7: stop(paste("The following functions were not found:", paste(fullNames[notFound], 
   collapse = ", ")))

【问题讨论】:

  • 一个包加载到一个专用环境中。 “污染”是什么意思?
  • importFrom 是我的第一种方法,但我已经导入了我调用的一个函数及其所有依赖函数,但我仍然收到一条消息,当我尝试时找不到一些这些依赖函数构建包。我认为这是鼠标的构建方式的结果。
  • 请参阅stackoverflow.com/a/40830959/4468078 并阅读import 包,它(几乎)完全符合您的要求。我还没有尝试过的唯一事情是您是否可以创建自己的环境而不是指定新环境的名称。另一个区别可能是import 将环境附加到搜索路径中,这可能不是您想要的(您可以通过分离它来修复)。

标签: r r-package


【解决方案1】:

我昨天遇到了同样的错误并提出了一个类似的问题(顺便说一句,该问题已经被否决了)。今天我找到了一个解决方案,我希望它也适用于您,也许您(或其他人)可以对此有所了解。

我正在开发一个 R 包并使用 roxygen2 来记录功能。我在描述文件的导入部分中列出了鼠标,因为我必须使用 mouse::mice 函数。在构建和检查包时,一切都很顺利,直到我真正运行调用 mouse::mice 的函数,此时我得到的错误与你得到的完全相同。

据我了解,这是导致问题的原因: 在使用鼠标的函数的文档部分,您需要添加以下位:

#' @importMethodsFrom mice
#' @importFrom mice mice

请注意,到目前为止,对于我使用过的大多数软件包,以下行已经绰绰有余:

#' @importFrom mice mice

显然老鼠也需要你添加@importMethodsFrom 指令。我的猜测是这是因为它使用的是 S4 类,但我对它们知之甚少,所以我只知道它是这样工作的。

我通过阅读此页面上的“S4”部分发现了这一点: http://r-pkgs.had.co.nz/namespace.html#imports

所以,回到你的具体情况,我猜你的函数的文档应该是这样的

#' @import data.table
#' @importFrom mice mice
#' @importMethodsFrom mice
#' @export
impute <- function(data, m = 5, max.iter = 5){...}

这对我来说很好。希望对你也有帮助。

【讨论】:

    【解决方案2】:

    包 'mice' 在内部调用来自全局环境的插补方法。根据作者的说法,这是为了允许提供您自己的自定义插补方法。因此,包也必须在全局环境中公开它们的默认实现。我认为这是纯粹判断的一个很好的例子——内部方法现在只能通过全局环境被包识别。这首先违背了打包代码的目的。如果你想允许你的包使用外部函数,那么只需提供一个 API 来将它们传递给包。

    你看到的错误信息是由函数'mice:::check_method'触发的:

    notFound <- !vapply(fullNames, exists, logical(1), mode = "function", inherits = TRUE)
    

    我的解决方法是从我自己的包中重新导出“老鼠”内部使用的方法(它内部使用“老鼠”,就像你的一样)。只需放入一个 R 文件并在其上运行 roxygen2:

    #' @importFrom mice mice
    
    #' @export
    mice.impute.pmm <- mice::mice.impute.pmm
    
    #' @export
    mice.impute.polyreg <- mice::mice.impute.polyreg
    

    当然,如果其他方法用于您的数据,您将需要导出它们。

    我的立场是,如果我需要污染全球环境,我会尽量减少污染,只需要“老鼠”工作所需的功能。

    【讨论】:

      猜你喜欢
      • 2017-01-04
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2017-12-30
      • 1970-01-01
      • 1970-01-01
      • 2020-05-02
      • 1970-01-01
      相关资源
      最近更新 更多