在没有警告的情况下跳过包文档中的参数

Question

我创建了一个 R 程序包并设置了一个泛型，其中一些参数的默认值设置为 NULL。这些参数不会由用户提供，因此我想从文档中跳过它们（使用 roxygen2）但不会导致在 R CMD check.

中收到警告

一个例子：

#' Do that with myFoo...
#' 
#' `myFoo` ...
#' 
#' `myFoo` description...
#' 
#' @param object An object of myBar class
#' @param a A numeric value...
#' 
#' @return Smth
#' 
#' @name myFoo
#' @export
#' 
methods::setGeneric("myFoo", function(object, a, b=NULL, c=NULL) standard("myFoo"))


# User level
methods::setMethod(f="myFoo",
    signature=signature(object="myBar", a="numeric"),
    function(object, a, b, c){

            Some checks...

            b <- smth
            c <- smth

            return(myFoo(object@myBarItem, a, b, c))
    }
)


# For "iternal" use
methods::setMethod(f="myFoo",
    signature=signature(object="myBar2", a="numeric", b="character", c="matrix"),
    function(object, a, b, c){

            Smth

            return(someValue)
    }
)

Answer 1

添加 @rdname 和 @aliases 似乎解决了这个问题。

#' Do that with myFoo...
#' 
#' `myFoo` ...
#' 
#' `myFoo` description...
#' 
#' @param object An object of myBar class
#' @param a A numeric value...
#' 
#' @return Smth
#'
#' @name myFoo
#' @rdname myFoo
#' @export
#'
#' @aliases myFoo,myBar,numeric,ANY,ANY-method
#' myFoo,myBar2,numeric,character,matrix-method
#' 
#' @importFrom methods setGeneric setMethod
#'
methods::setGeneric("myFoo", function(object, a, b=NULL, c=NULL) standard("myFoo"))


# User level
methods::setMethod(f="myFoo",
    signature=signature(object="myBar", a="numeric"),
    function(object, a, b, c){

            Some checks...

            b <- smth
            c <- smth

            return(myFoo(object@myBarItem, a, b, c))
    }
)


# For "iternal" use
methods::setMethod(f="myFoo",
    signature=signature(object="myBar2", a="numeric", b="character", c="matrix"),
    function(object, a, b, c){

            Smth

            return(someValue)
    }
)

在没有警告的情况下跳过包文档中的参数

Skip parameters from package documentation without warning

r

package

documentation

roxygen2