Roxygenで文書化するとき：@detailsで箇条書きリストを作るにはどうしたらいいですか？

Question

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

感謝

#' @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} 
##' } 
##' 

これで、詳細セクションのitemizeを使用できるようになります。 @paramセクションでも使用できます。

これが役に立ちます。

Answer 2

roxygen2 6.0.0以降、Rドキュメントでmarkdownを直接使用することができます。このいずれかを使用し、全体のパッケージのために値下げをオンまたは単一のファイルに@mdタグを追加するために、あなたの説明にRoxygen: list(markdown = TRUE)を含めること

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

。