r - 在 Roxygen 中记录时 : How do I make an itemized list in @details?

Question

向 roxygen2 添加逐项列表(例如在 @details 部分)的适当语法是什么？我可以创建 Latex 列表环境吗？

似乎换行符被简单地忽略了，即

#' @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 部分中使用它。

希望这有帮助。