Router ile belge belirleme işlevleri

Question

Herhangi bir R nesnesine, reklamlardan benzersiz bir attr hiçbir şey yapmayan bir fonksiyona sahibim. Baz demo:

Bu iyi Rd dosyası oluştururken hariç bir cazibe gibi çalışır

#' 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) 
} 

, ilgili kısmı:

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

Ve R CMD check çalışırken o foo(var) <- value olması gerektiği gibi tabii ki bir uyarı tetikler.

Herhangi bir ipucu gerçekten minnettar olurdu!

---

Güncelleme: teşekkürler o var gibi görünüyor richierocks için fix

Answer 1

Sen roxygen etiketi Burada @usage

benim paketlerin birinden bir örnek kullanabilirsiniz:

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

---

Bu, benim istediğim dokümantasyonla sonuçlanır:

Usage 

    pattern(x) <- value 

Arguments 
x surveydata object 

value New value