r - 在编写使用 Matrix 包的 R 包时，为什么我必须指定 Matrix::t() 而不是 t()？

Question

考虑在 R session 中定义的以下简单函数:

nathanvan@nathanvan-N61Jq:~$ R

R version 3.0.1 (2013-05-16) -- "Good Sport"
... snip ... 
> make.a.Matrix <- function(data, nrow, ncol) {
+    require(Matrix)
+    return( Matrix(data, nrow=nrow, ncol=ncol))
+ }
> 
> transpose.a.Matrix <- function(data, nrow, ncol  ) {
+   return(t( make.a.Matrix(data, nrow=nrow, ncol=ncol) ))
+ }
> 
> make.a.Matrix(1:12, 3, 4)
Loading required package: Matrix
Loading required package: lattice
3 x 4 Matrix of class "dgeMatrix"
     [,1] [,2] [,3] [,4]
[1,]    1    4    7   10
[2,]    2    5    8   11
[3,]    3    6    9   12
> transpose.a.Matrix(1:12, 3, 4)
4 x 3 Matrix of class "dgeMatrix"
     [,1] [,2] [,3]
[1,]    1    2    3
[2,]    4    5    6
[3,]    7    8    9
[4,]   10   11   12

如果我们将这些相同的函数放在一个包中， transpose.a.Matrix功能不再起作用。由于描述包创建过程太冗长，我只是发布了包 here 的副本。 .我已经发布了 DESCRIPTION和 NAMESPACE问题末尾的文件。如果其他文章是相关的，我也很乐意发布它们。请告诉我!

nathanvan@nathanvan-N61Jq:~$ R

R version 3.0.1 (2013-05-16) -- "Good Sport"
... snip ... 
> require(minimalbugexample)
Loading required package: minimalbugexample
Loading required package: Matrix
Loading required package: lattice
Loading required package: testthat
> make.a.Matrix(1:12, 3, 4)
3 x 4 Matrix of class "dgeMatrix"
     [,1] [,2] [,3] [,4]
[1,]    1    4    7   10
[2,]    2    5    8   11
[3,]    3    6    9   12
> transpose.a.Matrix(1:12, 3, 4)
Error in t.default(make.a.Matrix(data, nrow = nrow, ncol = ncol)) : 
  argument is not a matrix
> transpose.a.Matrix
function(data, nrow, ncol  ) {
  return(t( make.a.Matrix(data, nrow=nrow, ncol=ncol) ))
}
<environment: namespace:minimalbugexample>

我认为这里的关键是命名空间的一些奇怪之处。请注意，如果我调试该函数，我可以手动调用 Matrix::t它会在 base::t 时起作用失败并出现相同的错误。

> debug(transpose.a.Matrix)
> transpose.a.Matrix(1:12, 3, 4)
debugging in: transpose.a.Matrix(1:12, 3, 4)
debug at /home/nathanvan/Ubuntu One/workspace/experimental-design/software/minimalbugexample/R/use-Matrix-package.R#31: {
    return(t(make.a.Matrix(data, nrow = nrow, ncol = ncol)))
}
Browse[2]> t(Matrix(1:12, 3, 4))
Error in t.default(Matrix(1:12, 3, 4)) : argument is not a matrix
Browse[2]> t
function (x) 
UseMethod("t")
<bytecode: 0x46b0a88>
<environment: namespace:base>
Browse[2]> Matrix::t(Matrix(1:12, 3, 4))
4 x 3 Matrix of class "dgeMatrix"
     [,1] [,2] [,3]
[1,]    1    2    3
[2,]    4    5    6
[3,]    7    8    9
[4,]   10   11   12
Browse[2]> base::t(Matrix(1:12, 3, 4))
Error in t.default(Matrix(1:12, 3, 4)) : argument is not a matrix

并且还在使用 showMethods , 建议只使用 t应该找到合适的，即使它没有。

Browse[2]> showMethods('t')
Function: t (package base)
x="ANY"
x="CsparseMatrix"
x="dgeMatrix"
x="diagonalMatrix"
x="dppMatrix"
x="dsCMatrix"
x="dspMatrix"
x="dsTMatrix"
x="dsyMatrix"
x="dtpMatrix"
x="dtrMatrix"
x="dtTMatrix"
x="lgeMatrix"
x="lspMatrix"
x="lsTMatrix"
x="lsyMatrix"
x="ltpMatrix"
x="ltrMatrix"
x="ltTMatrix"
x="matrix"
    (inherited from: x="ANY")
x="Matrix"
x="ngeMatrix"
x="nspMatrix"
x="nsTMatrix"
x="nsyMatrix"
x="ntpMatrix"
x="ntrMatrix"
x="ntTMatrix"
x="pMatrix"
x="RsparseMatrix"
x="TsparseMatrix"

现在，我可以通过编辑包的源代码来“修复”它，以便 transpose.a.Matrix函数指定它需要 Matrix::t方法:

transpose.a.Matrix <- function(data, nrow, ncol  ) {
  require(Matrix)
  return(Matrix::t( make.a.Matrix(data, nrow=nrow, ncol=ncol) ))
}

但这似乎不需要它。我错过了什么？

我的描述文件是

Package: minimalbugexample
Title: 
Description: 
Version: 0.1
Author: Nathan VanHoudnos <nathanvan@letterafterFmail.com>
Maintainer: Nathan VanHoudnos <nathanvan@letterafterFmail.com>
Depends:
    R (>= 3.0.1),
    Matrix (>= 1.0),
    testthat
License: GPL
LazyData: true
Collate:
    'minimalbugexample-package.r'
    'use-Matrix-package.R'

我的 NAMESPACE 文件是

export(make.a.Matrix)
export(transpose.a.Matrix)

我可以根据要求发布额外的作品。

Answer 1

gitHub 上的一个工作示例

I put a working example on gitHub so that it is easy to browse the different files .

仅供引用，这不是一个最小的例子，因为它是用 devtools 构建的. “额外”是 (1) roxygen2注释是构建 NAMESPACE 文件的内容，并且 (2) 它结合了单元测试和 testthat .出于本示例的目的，所有这些都可以忽略。

关键修复

事实上，我所做的简短回答需要将我的 NAMESPACE 文件更改为:

export(make.a.Matrix)
export(transpose.a.Matrix)
importFrom(Matrix,Matrix)
importFrom(Matrix,t)

这样 R 就可以找到正确的转置版本。看到这个 post有关 R 如何搜索函数的详细描述。

虽然不是绝对必要的，但我修改了我的描述文件，使其更清晰:

Package: minimalbugexample
Title: 
Description: 
Version: 0.1.3
Author: Nathan VanHoudnos <nathanvan@letterafterFmail.com>
Maintainer: Nathan VanHoudnos <nathanvan@letterafterFmail.com>
Depends:
    R (>= 3.0.1),
    Matrix (>= 1.0)
Suggests:
    testthat (>= 0.7.1.99)
License: GPL
LazyData: true
Collate:
    'minimalbugexample-package.r'
    'use-Matrix-package.R'

请注意，我使用的是 Depends:为 Matrix而不是 Imports:以便用户能够使用 Matrix函数返回的对象。如果这个例子只使用了 Matrix内部的东西而不将其呈现给用户，我会使用 Imports: .

证明它有效

> require(minimalbugexample)
> make.a.Matrix(1:12, 3, 4)
3 x 4 Matrix of class "dgeMatrix"
     [,1] [,2] [,3] [,4]
[1,]    1    4    7   10
[2,]    2    5    8   11
[3,]    3    6    9   12
> transpose.a.Matrix(1:12, 3, 4)
4 x 3 Matrix of class "dgeMatrix"
     [,1] [,2] [,3]
[1,]    1    2    3
[2,]    4    5    6
[3,]    7    8    9
[4,]   10   11   12
> t( make.a.Matrix(1:12, 3, 4))
4 x 3 Matrix of class "dgeMatrix"
     [,1] [,2] [,3]
[1,]    1    2    3
[2,]    4    5    6
[3,]    7    8    9
[4,]   10   11   12

请注意，如果我指定了 Matrix，最后一个命令将会失败。在 Imports:而不是 Depends: .