2011-03-11 15 views
91

जिस तरह से Roxygen काम करना प्रतीत होता है कि पहली पंक्ति \title है, बाकी सब कुछ \details में है, और फिर @foo निर्देश उन चीजों को संभालते हैं। लेकिन आर दस्तावेज उससे भी अमीर है। मेरे पास आरआरडी फाइलों में "\section{Llamas}{Are they ungulates?}" हो सकता है।roxygen दस्तावेज़ों में मनमानी खंड

लेकिन मुझे रोक्सजेन को सभी विवरणों को लपेटने के अलावा कुछ भी करने के लिए नहीं मिल सकता है। क्या मैं कुछ भूल रहा हूँ?

मेरे पास एक हैकी समाधान है, जो मेरे \section से पहले एक बेजोड़ } चिपकाना है। यह \details अनुभाग समाप्त होता है। मुझे तब } को समाप्त नहीं करना है, क्योंकि रोक्सीजन \details को बंद करने में सोचने में एक चिपक जाता है। Eeeeeurrrrrrrrgh।

+2

बहुत बढ़िया सवाल फ़ाइल .Rd निम्नलिखित देता है। मुझे संदेह है कि आप सही हैं कि इस समय यह नहीं किया जा सकता है। लेकिन हैडली विकम ने हाल ही में उल्लेख किया कि वह रॉक्सीजन के भविष्य के विकास की कुंजी कैसे रखता है, इसलिए मुझे आशा है कि निकट भविष्य में कुछ अद्भुत दिखाई देगा। – Andrie

+4

इस बात पर निर्भर करते हुए कि आप कितनी गहराई से प्राप्त करना चाहते हैं, आप हेडली की मदद करने के लिए जो कुछ भी कर रहे हैं उसकी सहायता करने की पेशकश कर सकते हैं। मुझे पता है कि उसका काम अद्भुत है, लेकिन आखिरकार, 'वेल्ल, वह सिर्फ ज़िस लड़का है, तुम्हें पता है?'। हो सकता है कि हैडली ने गिटब https://github.com/hadley/roxygen पर प्रकाशित कोड को देखना चाहें और शायद उसे एक ईमेल भेजें और उससे पूछें ... – PaulHurleyuk

+1

निश्चित रूप से। मैंने यहां हैडली को भी देखा है, इसलिए वह जागरूक हो सकता है। सबसे पहले मैंने सोचा कि मैं दस्तावेज़ों में कुछ चूक गया था, जैसे कि "@ सेक्शन ल्लामास" निर्देश या इसी तरह। – Spacedman

उत्तर

16

यह समर्थन जोड़ा गया है (कम से कम roxygen2 में)। आपको बस @section Llamas: जोड़ने की आवश्यकता है और तब उसके बाद कुछ भी नया निर्देश मिलने तक ललमस सेक्शन में होगा। यहाँ एक उदाहरण

#' Llama llama llama 
#' 
#' More about llamas 
#' 
#' @section Llamas: 
#' Are they ungulates? 
#' 
#' @section Not llamas: 
#' This section is not about llamas. It is not very interesting. 
#' 
#' @param notused A parameter that isn't used at all! 
#' @export 
llama <- function(notused){ 
    return("LLAMA LLAMA LLAMA") 
} 

जो

\name{llama} 
\alias{llama} 
\title{Llama llama llama} 
\usage{ 
    llama(notused) 
} 
\arguments{ 
    \item{notused}{A parameter that isn't used at all!} 
} 
\description{ 
    More about llamas 
} 
\section{Llamas}{ 
    Are they ungulates? 
} 

\section{Not llamas}{ 
    This section is not about llamas. It is not very 
    interesting. 
} 
+3

Llamas रॉक में '@ सेक्शन' टैग देखें !!!! – BrodieG