roxygen을 사용하여 문자가 아닌 함수를 내보내는 방법은 무엇입니까?

Question

this question에 대한 후속 질문이 있습니다. 내 클래스 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 메시지를 제공합니다. this question을 올바르게 이해하면 '+.expo'은 각 기능이 (소문자 또는 대문자) 문자로 시작해야하므로 잘못된 기능 이름입니다. 이제 ggplot2 함수를 제공 할 수있는 방법이 궁금합니다 '+.gg'? 더 중요한 것은 : 내 패키지가 클래스 별 + 함수를 어떻게 제공 할 수 있는가?

Answer 1

R은 함수가 문자 이외의 문자로 시작하도록 허용하지만 기본값은 roxygen입니다. 그러나 인수로 @rdname을 사용하면 문서에서 사용 된 대체 이름을 부여 할 수 있습니다. 그래서, 당신의 .R - 파일은 here을 찾을 수있는 언급 ggplot2 기능 '+.gg'에

#' @param a first object 
#' @param b second object 
#' @return exponential result 
#' @export 
#' @rdname expo-add 
'+.expo' <- function(a, b) a^b 

것처럼 .R - 파일을 볼 수 있습니다.