我在this question上有一个跟进问题。假设我想为我的班级expo
设置一个'+.expo' <- function(a, b) a ^ b
r <- 2; class(r) <- "expo"
s <- 3; class(s) <- "expo"
r + s # gives 8
函数。在我的正常R会话中,以下工作完美
devtools::document()
但是运行Skipping invalid path: .expo.Rd
会给我'+.expo'
消息。如果我正确理解this question,ggplot2
是函数的无效名称,因为每个函数都必须以(小写或大写)字母开头。现在我想知道'+.gg'
如何提供函数+
?更重要的是:我的包如何提供特定于类的R
函数?
答案 0 :(得分:2)
roxygen
允许函数以字母开头,但默认情况下@rdname
不是。但是您可以使用参数.R
为这些函数提供文档中使用的替代名称。因此,您的#' @param a first object
#' @param b second object
#' @return exponential result
#' @export
#' @rdname expo-add
'+.expo' <- function(a, b) a ^ b
文件可能看起来像
.R
ggplot2
- 提到的'+.gg'
函数{{1}}的文件可以找到here。