أقسام تعسفية في مستندات roxygen



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

الطريقة التي يبدو أن Roxygen يعمل بها هي أن السطر الأول هو \title ، وكل شيء آخر موجود في \details ، ومن ثم فإن أي توجيهات @foo تتعامل مع هذه الأشياء. لكن وثائق R أكثر ثراء من ذلك. يمكنني الحصول على "\section{Llamas}{Are they ungulates?}" في ملفات .Rd.

ولكن لا يمكنني الحصول على Roxygen للقيام بأي شيء آخر غير تغليفه في \ التفاصيل. هل فاتني شيء؟

لدي حل للهاكر ، وهو التمسك بميزة لا مثيل لها قبل \section my. هذا ثم ينهي القسم \details . بعد ذلك يجب أن لا أضع نهاية } ، لأن roxygen يلتصق بواحد يفكر في إغلاق \details . Eeeeeurrrrrrrrgh.





roxygen