如何导出函数从没有字母开始使用roxygen？
如何导出函数从没有字母开始使用roxygen？
提问于 2017-04-20 13:37:50
我有一个关于这个问题的后续问题。假设我想为我的类+函数提供一个expo函数。在我的正常R会话中，以下内容工作得很好
'+.expo' <- function(a, b) a ^ b
r <- 2; class(r) <- "expo"
s <- 3; class(s) <- "expo"
r + s # gives 8但是运行devtools::document()会给我Skipping invalid path: .expo.Rd消息。如果我正确理解这个问题，则'+.expo'是一个函数的无效名称，因为每个函数都必须以(小写或大写)字母开头。现在我想知道ggplot2如何提供'+.gg'函数？更重要的是:我的包如何提供特定于类的+函数？
回答 1
Stack Overflow用户
回答已采纳
发布于 2017-04-20 13:37:50
R允许函数从其他东西开始，然后是字母，但默认情况下不允许使用roxygen。但是您可以使用参数@rdname为这些函数提供文档中使用的替代名称。所以，您的.R-file可能看起来像
#' @param a first object
#' @param b second object
#' @return exponential result
#' @export
#' @rdname expo-add
'+.expo' <- function(a, b) a ^ b.R-File到所述的ggplot2函数'+.gg'可以找到这里。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/43521194
复制相关文章
相似问题
腾讯云开发者
