roxygen을 사용한 세터 함수 문서화

Question

모든 R 객체에 고유 한 attr 광고 만 허용하는 기능이 있습니다. 자료 데모 :

이 좋은 RD 파일을 생성을 제외하고 매력처럼 작동

#' Setter function 
#' @param x an R object 
#' @param value a character value to set 
#' @export 
`foo<-` <- function(x, value){ 
    attr(x, 'foo') <- value 
    return(x) 
} 

, 관련 부분 :

\usage{ 
    foo(var, value) <- value 
} 

그리고 R CMD check을 실행하는 동안이 foo(var) <- value을해야으로 물론이 경고를 트리거합니다.

힌트는 정말 감사하겠습니다!

---

업데이트 : 감사는이 보인다 richierocks에 fix

Answer 1

당신은 roxygen 태그 여기 @usage

내 패키지 중 하나의 예입니다 사용할 수 있습니다

#' @rdname pattern 
#' @usage pattern(x) <- value 
#' @param value New value 
#' @export pattern<- 
"pattern<-" <- function(x, value=c("^", "($|(_\\d+(_\\d+)*)$)")){ 
    attr(x, "pattern") <- value 
    x 
} 

을

---

결과로 원하는 문서가 생성됩니다.

Usage 

    pattern(x) <- value 

Arguments 
x surveydata object 

value New value