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

这将允许您在详细信息部分中使用逐项.您也可以在@param部分中使用它.

希望这可以帮助.

Answer 2

从roxygen2 6.0.0开始,您可以直接在R文档中使用markdown.

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

要使用此功能,请Roxygen: list(markdown = TRUE)在说明中包含为整个包打开markdown或将@md标记添加到单个文件中.