When documenting in Roxygen: How do I make an itemized list in @details?
What is the appropriate syntax to add an itemized list to roxygen2, for instance, in the @details section? Can I create a latex list environment?
It seems that line breaks are simply ignored, i.e.
#' @details text describing parameter inputs in more detail
#'
#' parameter 1: stuff
#'
#' parameter 2: stuff
thanks!
Here is a roxygen2 example following your problem formulation.
##'
##' @details text describing parameter inputs in more detail.
##' \itemize{
##' \item{"parameter 1"}{Stuff}
##' \item{"parameter 2"}{Stuff}
##' }
##'
This will allow you to use itemize in details section. You can also use it in the @param sections.
Hope this helps.
Since roxygen2 6.0.0 you can use markdown directly in your R documentation.
#' @details text describing parameter inputs in more detail.
#' * parameter 1 stuff
#' * parameter 2 stuff
#' @md
To use this either include Roxygen: list(markdown = TRUE)
in your description to turn markdown on for the whole package or add the @md
tag to a single file.