roxygen

Question

के साथ सेटर फ़ंक्शंस दस्तावेज मेरे पास एक ऐसा फ़ंक्शन है जो किसी भी आर ऑब्जेक्ट के लिए अद्वितीय attr विज्ञापनों से अधिक कुछ नहीं करता है। बेस डेमो:

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