आर सीएमडी जांच चेतावनी: प्रलेखन ऑब्जेक्ट में उपयोग के साथ कार्य/विधियां ... लेकिन कोड

Question

में मैं एक पैकेज लिख रहा हूं लेकिन एक लगातार R CMD check चेतावनी मुझे पैकेज को खत्म करने और इसे CRAN पर पोस्ट करने से रोकती है। मैं इनलाइन दस्तावेज के लिए roxygen2 का उपयोग करता हूं, हालांकि यह संभवतः त्रुटि का मूल कारण नहीं है।

यदि आपको पता है कि इस चेतावनी को हटाने के लिए क्या करना है, तो मैं roxygen2 का उपयोग करके इसे करने का एक तरीका समझ सकता हूं।

मैं अपने पैकेज चेक से चेतावनीFunctions/methods with usage in documentation object ... but not in codeको कैसे हटा सकता हूं?

---

R CMD check चेतावनी:

* checking for code/documentation mismatches ... WARNING 
Functions/methods with usage in documentation object 'names<-' but not in code: 
    names<- 

समारोह और roxygen प्रलेखन:

#' Updates names and variable.labels attribute of surveydata. 
#' 
#' @name names<- 
#' @rdname names 
#' @aliases names<- names<-.surveydata 
#' @param x surveydata object 
#' @param value New names 
#' @method names<- surveydata 
#' @usage names(x) <- value 
"names<-.surveydata" <- function(x, value){ 
    invisible(NULL) 
} 

जिसके परिणामस्वरूप .rd प्रलेखन फ़ाइल:

\name{names<-} 
\alias{names<-} 
\alias{names<-.surveydata} 
\title{Updates names and variable.labels attribute of surveydata.} 
\usage{ 
    names(x) <- value 
} 
\arguments{ 
    \item{x}{surveydata object} 

    \item{value}{New names} 
} 
\description{ 
    Updates names and variable.labels attribute of 
    surveydata. 
} 

---

मैं आधार आर में names<- के लिए प्रलेखन के साथ मेरी प्रलेखन पार जाँच की है, और यह समान लगता है:

\title{ The Names of an Object} 
\name{names} 
\alias{names} 
\alias{names.default} 
\alias{names<-} 
\alias{names<-.default} 
\keyword{attribute} 
\description{Functions to get or set the names of an object.} 

---

संबंधित प्रश्न (लेकिन मैं पहले से ही सुझाव और फिर भी प्रयास विफल लागू कर दिया है):

• How to properly document a S3 method of a generic from a different package, using Roxygen?

---

मैं गलत कहां जा रहा हूं? मैं पैकेज चेतावनी से इस चेतावनी को कैसे हटा सकता हूं?

Answer 1

रोड फ़ाइल में \usage अनुभाग में निम्न शामिल करने की जरूरत है:

\method{names}{surveydata}(x) <- value 

यह स्वचालित रूप से @method लाइन द्वारा नहीं डाला जाता है (मुझे लगता है कि केवल \method{names}{surveydata}(x) जोड़ देगा अनुमान?) तो आप एक स्पष्ट की जरूरत है @usage अनुभाग जिसमें उपर्युक्त शामिल है। जैसे

#' @usage \\method{names}{surveydata}(x) <- value 

कुछ मैं भी विधि स्पष्ट है कि आर :: आधार में रोड फ़ाइल के साथ संघर्ष के रूप में सामान्य नहीं का उल्लेख करने के @name और @alias वर्गों बदल जाएगा।

अनिवार्य रूप से, चेतावनी तथ्य से आ रही है कि अपने पैकेज नहीं है अभी तक एक समारोह "names<-" शामिल आप \usage{} में यह प्रयोग कर रहे हैं।