При документировании в 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.

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

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