R 包中的 .First.lib 习惯用法

Question

我在很多 R 包的 .First.lib 函数中看到以下习惯用法：

fullName <- paste("package", pkgname, sep=":")
myEnv <- as.environment(match(fullName, search()))
barepackage <- sub("([^-]+)_.*", "\\1", pkgname)
dbbase <- file.path(libname, pkgname, "R", barepackage)
rm(.First.lib, envir = myEnv)
lazyLoad(dbbase, myEnv)
if(exists(".First.lib", envir = myEnv, inherits = FALSE)) {
    f <- get(".First.lib", envir = myEnv, inherits = FALSE)
    if(is.function(f))
        f(libname, pkgname)
    else
        stop(gettextf("package '%s' has a non-function '.First.lib'",
                      pkgname),
             domain = NA)
}

我知道 .First.lib 函数在加载包时运行。

我知道上面的代码定义了包的环境并设置了路径，但我不明白为什么它在显式删除 .First.lib 函数后还要寻找 .First.lib 函数。是什么让上述习语如此普遍？将其包含在 R 包中是“最佳实践”吗？

Answer 1

这种成语很古老。包应该有命名空间并使用 .onLoad、.onUnload 和 .onAttach。例如：

.onLoad <- function(libname, pkgname){
     # do whatever needs to be done when the package is loaded
     # some people use it to bombard users with 
     # messages using 
     packageStartupMessage( "my package is so cool" )
     packageStartupMessage( "so I will print these lines each time you load it")
}

最好通过将以下内容添加到描述文件来避免调用lazyLoad函数的整个事务：

LazyLoad: true

Answer 2

您问为什么脚本之前删除了 .First.Lib 时它还要查找它。 lazyLoad 加载 R 对象的数据库，在上面的代码中该数据库被加载到环境 myEnv 中。加载到该环境中的对象集包含 .First.Lib 并不是不可想象的，而代码正在寻找它。事实上，我猜其目的是仅运行存储在加载的对象数据库中的.First.Lib。

没有命名空间的包中的另一个常见习惯用法是这样的（来自 vegan 包）：

.First.lib <- function(lib, pkg)  {
    library.dynam("vegan", pkg, lib)
    packageStartupMessage("This is vegan ",
                          utils::packageDescription("vegan", field="Version"),
                          appendLF = TRUE)
}

这会加载可供使用的已编译代码，并打印一条带有包名称和版本号的简单启动消息。这在本质上与 @Romain 的答案的 .onLoad 类似，但没有 NAMESPACE。