2011-08-08 13 views
7

रोक्सीजन ने अपना काम बहुत आसान बना दिया है और ज्यादातर मामलों में यह अच्छा और सहज है। एक बात है कि मैं हालांकि पता लगा कभी नहीं किया है, ताकि roxygenize("myPackage") का परिणामउदाहरण अनुभाग में इंडेंटेशन को संरक्षित करना

युक्त कैसे @examples वर्गों में खरोज संरक्षित करने के लिए
#' @examples 
#' sapply(1:10, function(i){ 
#'  x <- rbind(matrix(rnorm(20), 10, 2), 
#'    matrix(rnorm(20), 10, 2) + i) 
#'  myFunc(x) 
#' } 

\examples{sapply(1:10, function(i){ 
    x <- rbind(matrix(rnorm(20), 10, 2), 
       matrix(rnorm(20), 10, 2) + i) 
    myFunc(x) 
}} 
बजाय

\examples{sapply(1:10, function(i){ 
x <- rbind(matrix(rnorm(20), 10, 2), 
matrix(rnorm(20), 10, 2) + i) 
myFunc(x) 
}} 

होगा यह एक छोटा सा विवरण है, लेकिन यह सबसे सरल उदाहरणों को पढ़ने के लिए अनावश्यक रूप से कठिन बनाता है, इसलिए अगर कोई मेरी मदद कर सकता है तो मैं इसकी सराहना करता हूं।

संपादित करें: यह बग roxygen के बाद के संस्करणों में ठीक किया गया था।

+0

क्या आप 'roxygen' या' roxygen2' का उपयोग कर रहे हैं? मुझे यकीन है कि यह roxygen2 में नहीं होता है, और यदि यह एक बग है, और इसकी सूचना दी जानी चाहिए। – hadley

+0

मैं सादे पुराने 'roxygen' का उपयोग कर रहा था लेकिन समस्या के बाद मैं' roxygen2' अद्यतन किया। gsk3 का समाधान दोनों के लिए काम करता है लेकिन मुझे लगता है कि यह वैसे भी बेहतर रिपोर्ट किया जाएगा। मैं उसको कैसे करू? – Backlin

+0

कृपया https://github.com/klutometis/roxygen/issues – hadley

उत्तर

4

शायद छोटे उदाहरणों के लिए बहुत अधिक ओवरहेड, लेकिन लंबे उदाहरण के लिए आप फ़ाइल में खींचने के लिए @example relative/path/to/example कर सकते हैं, जो इंडेंटिंग अधिकार प्राप्त करना चाहिए।

+0

धन्यवाद, यह एक आकर्षण की तरह काम करता है! ओवरहेड भी बुरा नहीं है क्योंकि यह केवल कुछ प्रासंगिक उदाहरणों पर लागू होता है, खासकर जब इंडेंटेशन को मैन्युअल रूप से सही करने के निषिद्ध बड़े बोझ की तुलना में। – Backlin

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