web-dev-qa-db-ja.com

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

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

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

私にはハッキーな解決策があります。それは、私の}の前に比類のない\sectionを貼り付けることです。これで、\detailsセクションが終了します。次に、末尾の}を入力する必要はありません。これは、roxygenが\detailsを閉じることを考えているためです。 Eeeeeurrrrrrrrgh。

rroxygen
94
Spacedman

このサポートが追加されました（少なくとも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.
}
22
Dason