2013-03-05 14 views
11

मैंने अपने स्वयं के उपयोग के लिए एक छोटा पैकेज लिखा है, और devtools का उपयोग करके सब कुछ ठीक हो गया है। हालांकि, मैंने आर सीएमडी जांच को चलाने की कोशिश की, और कई त्रुटियां मिलीं, प्रतीत होता है क्योंकि मेरे उपयोग और उदाहरण बेस आर से फ़ंक्शंस का उपयोग करते हैं जो मेरे पैकेज में नहीं हैं, उदाहरण के लिए यहां मेरा न्यूनतम कार्य है, और रॉक्सीजन दस्तावेज़आर सीएमडी से प्रलेखन ऑब्जेक्ट में alias के बिना nias में त्रुटि ऑब्जेक्ट्स चेक

#' Function to Sort a dataframe with a given list of columns 
#' Cribbed from Spector, P. (2008). "Data Manipulation with R", UseR! Springer. Pg78 
#' @param df Dataframe to be sorted 
#' @param ... list of columns to sort on 
#' @return A sorted dataframe 
#' @author "Paul Hurley" 
#' @export 
#' @usage with(dataframe,sortframe(dataframe,column1, column2, column3)) 
#' @examples with(iris,sortframe(iris,Sepal.Length,Sepal.Width,Petal.Length)) 
sortframe<-function(df,...){df[do.call(order,list(...)),]} 

और आर सीएमडी चेक देता

Undocumented arguments in documentation object 'sortframe' 
    'dataframe' 'sortframe(dataframe, column1, column2, column3)' 
Documented arguments not in \usage in documentation object 'sortframe': 
    'df' '...' 
Objects in \usage without \alias in documentation object 'sortframe': 
    'with' 

वहाँ एक रास्ता बताने के लिए आर सीएमडी चेक है/roxygen2 कि इन कार्यों आधार में वर्णित हैं?

उत्तर

3

आपको @usage टैग शामिल नहीं करना चाहिए। रोक्सीजन इसे आपके कोड से अनुमानित करेगा। आपका @usage वास्तव में एक उदाहरण है। आर शिकायत कर रहा है क्योंकि आप उन ऑब्जेक्ट्स का जिक्र कर रहे हैं जो आपकी फ़ंक्शन परिभाषा में बिल्कुल नहीं हैं। @usage, यदि आप इसे अपने आप में डालने का आग्रह करते हैं, तो केवल sortframe, df, और ... का संदर्भ लेना चाहिए। चूंकि आपके पास पहले से @example है, इसलिए आपको @usage टैग को छोड़ने में सक्षम होना चाहिए।

संबंधित मुद्दे