r - roxygen ドキュメントの任意のセクション

Question

Roxygenが動作するように見える方法は、最初の行が であり、他の\titleすべてが にあり\details、その後、すべての@fooディレクティブがそれらを処理するというものです。しかし、R のドキュメントはそれよりも豊富です。"\section{Llamas}{Are they ungulates?}".Rd ファイルを使用できます。

しかし、\details ですべてをラップする以外に Roxygen に何かをさせることはできません。何か不足していますか？

}の前に比類のないものを貼り付けるというハックな解決策があり\sectionます。これで\detailsセクションは終了です。roxygen}は\details. ええええええええ。

Answer 1

このサポートが追加されました (少なくとも roxygen2 では)。追加するだけ@section Llamas:で、新しいディレクティブが満たされるまで、その後はすべて 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.
}