Lors de la documentation dans Roxygen : comment puis-je créer une liste détaillée dans @details ?

Question

Quelle est la syntaxe appropriée pour ajouter une liste détaillée à roxygen2, par exemple, dans la section @details ? Puis-je créer un environnement de liste latex ?

Il semble que les sauts de ligne soient simplement ignorés, c'est-à-dire

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

Merci!

Answer 1

Voici un exemple roxygen2 suivant la formulation de votre problème.

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

Cela vous permettra d'utiliser itemize dans la section des détails. Vous pouvez également l'utiliser dans les sections @param.

J'espère que cela t'aides.

Answer 2

Depuis roxygen2 6.0.0, vous pouvez utiliser Markdown directement dans votre documentation R.

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

Pour l'utiliser, incluez Roxygen: list(markdown = TRUE) dans votre description pour activer la démarque pour l'ensemble du package ou ajoutez la @md à un seul fichier.