如何从另一个包中仅导入一个函数,而不加载整个命名空间

问题描述 投票:0回答:3

假设我正在开发一个名为

foo
的包,它想使用
description
包中的
memisc
函数。我不想导入整个
memisc
命名空间,因为 :

  1. 不好了
  2. memisc
    覆盖了基本的
    aggregate.formula
    函数,这会破坏一些东西。例如,
    example(aggregate)
     会惨败。

该软件包包含以下文件:

描述

Package: foo
Version: 0.0
Title: Foo
Imports:
    memisc
Collate:
    'foo.R'

命名空间

export(bar)
importFrom(memisc,description)

R/foo.R

##' bar function
##'
##' @param x something
##' @return nothing
##' @importFrom memisc description
##' @export

`bar` <- function(x) {
    description(x)
}

我认为使用

importFrom
 不会加载整个
memisc
命名空间,而只会加载
namespace::description
,但事实并非如此。从香草 R 开始:

R> getS3method("aggregate","formula")
## ... function code ...
## <environment: namespace:stats>
R> library(foo)
R> getS3method("aggregate","formula")
## ... function code ...
## <environment: namespace:memisc>
R> example(aggregate)
## Fails

那么,你知道如何从

description
导入
memisc
函数而不在我的环境中获得
aggregate.formula
吗?

r namespaces
3个回答
28
投票

你不能。

如果您在

memisc
字段中声明
Imports:
,则加载包时将加载命名空间,并且您的包将可以找到导出的对象。 (如果您在
Depends:
中指定它,命名空间将被加载并附加到搜索路径,这使得导出的对象可以通过任何代码找到。)

加载命名空间的一部分是使用泛型注册方法。 (我查看了,但找不到说明这一点的规范文档;我将诉诸函数在

NAMESPACE
文件中声明为 S3 方法的事实作为证据。)定义的方法与通用方法一起保留,并具有可见性泛型函数的(或者,也许,泛型函数的命名空间)。

通常,包将为它创建的泛型或它定义的类定义一个方法。 S3 对象系统没有正式定义 S3 类(或创建该类的包)的机制,但总体思路是,如果该包定义了返回具有该类属性的对象的函数(并且是唯一一个确实),该类是该包的类。如果这两个条件满足的话,就不会有问题。如果泛型是在包中定义的,则只有附加包才能找到;如果该类是在包中定义的,则该类的对象仅在附加并使用该包时才存在(因此会被分派)。

memisc
示例中,两者都不成立。
aggregate
泛型在
stats
包中定义,
formula
对象也在
stats
包中定义(基于定义
as.formula
[.formula
等的包),因为它既不是
 memisc
的泛型也不是
memisc
的对象,如果
memisc
只是加载但未附加,甚至可以看到效果(以及分派到的方法)。

有关此问题的另一个示例,但对于

reorder.factor
,请参阅 重新排序因子会给出不同的结果,具体取决于加载的包

一般来说,向包不控制对象或泛型的泛型添加方法并不是一个好习惯;如果它覆盖核心包中的方法,则加倍如此;如果它不是核心包中现有功能的向后兼容功能,那就太糟糕了。

对于您的示例,您最好将

memisc::describe
的代码复制到您的包中,尽管这种方法有其自身的问题和注意事项。


4
投票

需要注意的是,我不太熟悉 R 环境和命名空间,也不熟悉这是否可以在包中工作 - 我在编程中使用的解决方法是使用

::
将函数复制到我自己的函数中。

加载整个包可能会产生未知的后果,正如OP问题的评论中所讨论的,但它似乎没有将包的函数名称附加到R命名空间并掩盖现有的函数名称。

示例:

my_memisc_description <- memisc::description


0
投票

使用

include.only

library(dplyr, include.only = "select")

# So `select` works:
cars |> select(speed) |> head(2)
#>   speed
#> 1     4
#> 2     4

# But other dplyr functions do not: 
cars |> slice(1:5)
#> Error in slice(cars, 1:5): could not find function "slice"

另请参阅:

exclude

来源: https://stat.ethz.ch/R-manual/R-devel/library/base/html/library.html

© www.soinside.com 2019 - 2024. All rights reserved.