2017-04-20 60 views
0

我對this question有跟進問題。假設我想爲我的類expo提供一個自己的+函數。在我的正常R對話以下作品完美如何導出不使用roxygen的字母開始的函數?

'+.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消息。如果我正確理解this question,則'+.expo'是函數的無效名稱,因爲每個函數都必須以(小寫或大寫)字母開頭。現在我想知道ggplot2如何提供功能'+.gg'?更重要的是:我的軟件包如何提供特定類別的+功能?

回答

0

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 - 文件所提到的ggplot2功能'+.gg'可以發現here

相關問題