Когда вы регистрируетесь в Roxygen: как создать список в @details?

Каков подходящий синтаксис для добавления списка товаров в roxygen2, например, в разделе @details? Могу ли я создать среду списка латексов?

Кажется, что разрывы строк просто игнорируются, т.е.

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

спасибо!

Ответ 1

Вот пример roxygen2, следующий за вашей формулировкой проблемы.

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

Это позволит вам использовать раздел детализации в деталях. Вы также можете использовать его в разделах @param.

Надеюсь, что это поможет.

Ответ 2

Так как roxygen2 6.0.0 вы можете использовать markdown непосредственно в своей документации R.

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

Чтобы использовать это, включите Roxygen: list(markdown = TRUE) в описание, чтобы включить уценку для всего пакета или добавить тег @md в один файл.