r - Roxygenで文書化する場合：@detailsで項目別リストを作成するにはどうすればよいですか？

Question

たとえば、@ detailsセクションで、項目別リストをroxygen2に追加するための適切な構文は何ですか？ラテックスリスト環境を作成できますか？

改行は単に無視されているようです。

#' @details text describing parameter inputs in more detail
#'
#' parameter 1: stuff
#' 
#' parameter 2: stuff

ありがとう！

Answer 1

これは、問題の定式化に続くroxygen2の例です。

##'
##' @details text describing parameter inputs in more detail.
##' \itemize{
##'  \item{"parameter 1"}{Stuff}
##'  \item{"parameter 2"}{Stuff}
##' }
##'

これにより、詳細セクションでアイテム化を使用できるようになります。@paramセクションでも使用できます。

お役に立てれば。

Answer 2

roxygen2 6.0.0以降、Rドキュメントで直接マークダウンを使用することができます。

#' @details text describing parameter inputs in more detail.
#' * parameter 1 stuff
#' * parameter 2 stuff
#' @md

これを使用するにRoxygen: list(markdown = TRUE)は、説明にパッケージ全体のマークダウンをオンにするか、@mdタグを1つのファイルに追加します。