[ACCEPTED]-When documenting in Roxygen: How do I make an itemized list in @details?-roxygen

Accepted answer
Score: 70

Here is a roxygen2 example following your 4 problem formulation.

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

This will allow you 3 to use itemize in details section. You can 2 also use it in the @param sections.

Hope 1 this helps.

Score: 45

Since roxygen2 6.0.0 you can use markdown 4 directly in your R documentation.

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

To use 3 this either include Roxygen: list(markdown = TRUE) in your description 2 to turn markdown on for the whole package 1 or add the @md tag to a single file.

More Related questions