从 Matrix 包中导入 S4 函数

Question

Matrix 包定义了一大堆用于矩阵相乘的 S4 方法，这些方法由 S4 通用函数 %*%、crossprod 和 tcrossprod 分派。

如何导入“%*%”方法，以便在我自己的包中使用？这段代码在我运行devtools::document()时失败：

#' @title my function
#'
#' @description Does magic Matrix stuff
#' @import methods
#' @importFrom Matrix "%*%" Diagonal
myfun <- function(x, y){
  x %*% Diagonal(x=y)
}

如果 x 是稀疏矩阵，我想确保此函数使用 Matrix 包中的稀疏矩阵乘法方法。但是当我运行devtools::document() 时，出现以下错误：

Updating mypackage documentation
Loading mypackage
Error: object ‘%*%’ is not exported by 'namespace:Matrix'

Answer 1

您应该使用@importMethodsFrom 并删除运算符周围的引号。您可能还想使用@export 导出函数（您可能已经知道这一点，但它使答案更完整）。以下对我有用，没有错误。

#' @title my function
#'
#' @description Does magic Matrix stuff
#' @import methods
#' @importFrom Matrix Diagonal
#' @importMethodsFrom Matrix %*%
#' @export
myfun <- function(x, y){
    x %*% Diagonal(x=y)
}