Roxygen डॉक्स में मनमानी अनुभाग

Question

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

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

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

Comments

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

— एंड्री

आप कितनी गहराई में जाना चाहते हैं, इस पर निर्भर करते हुए, आप हैडली को उसकी मदद करने की पेशकश कर सकते हैं। मुझे पता है कि उनका काम अद्भुत है, लेकिन आखिरकार, 'वेल, वह सिर्फ ज़िस आदमी है, आप जानते हैं?'।

— होडले

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

— १

मुझे यकीन है कि लामा पसंद करते हैं। बस इतना ही।

— जेडी लॉन्ग

@sectionRoxygen2 में टैग देखें

— Hadley

Answer 1

यह समर्थन जोड़ा गया है (कम से कम 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")
}

जो .Rd फ़ाइल के लिए निम्नलिखित देता है

\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.
}