1. ホーム
  2. r

[解決済み] roxygen ドキュメント内の任意のセクション

2023-02-07 10:31:26

質問

方法 ロキジェン が動作するように見えるのは、最初の行が \title で、それ以外はすべて \details に、そして任意の @foo ディレクティブがそれらを処理します。しかし、Rのドキュメントはそれよりも豊富です。私は "\section{Llamas}{Are they ungulates?}" を .Rd ファイルに書くことができます。

しかし、私はRoxygenにそれをすべて "werap in \details "で包む以外のことをさせることができないのです。何か見落としているのでしょうか?

私は、非対応な解決策を持っていて、それは、マッチしない } の前に \section . これは \details セクションを終了します。では、最後の } を閉じると思ってしまうからです。 \details . えーっ。

どのように解決するのですか?

(少なくとも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.
}