¿Cuál es la sintaxis apropiada para agregar una lista detallada a roxygen2, por ejemplo, en la sección @details? ¿Puedo crear un entorno de lista de látex?Al documentar en Roxygen: ¿Cómo puedo hacer una lista detallada en @details?
Parece que los saltos de línea son simplemente ignorados, es decir
#' @details text describing parameter inputs in more detail
#'
#' parameter 1: stuff
#'
#' parameter 2: stuff
gracias!
Aquí hay un ejemplo de roxygen2 después de la formulación de su problema.
##'
##' @details text describing parameter inputs in more detail.
##' \itemize{
##' \item{"parameter 1"}{Stuff}
##' \item{"parameter 2"}{Stuff}
##' }
##'
Esto le permitirá utilizar detalles en la sección de detalles. También puede usarlo en las secciones @param.
Espero que esto ayude.
¿Puede indicarme la documentación en la que encontró esto? Estoy teniendo dificultades para descifrar la sintaxis de algunas de las funciones de Latex en Roxygen. –
@JeffAllen Acabo de revisar la sección http://cran.r-project.org/doc/manuals/R-exts.html#Lists-and-tables del manual "Writing R Extensions" y lo probé en Roxygen, que funciona bien para mí ¿Hay algún problema específico que estés teniendo? –
@JeffAllen Tenga en cuenta que este es solo el estilo estándar R doc (.Rd) para listas, que es solo el estilo LaTeX. Los problemas tanto con roxygen como con .Rd es que puede ser difícil predecir cuándo algo que funciona en tex funcionará en .Rd, y cuando lo que funciona en .Rd funcionará en roxygen ... – cboettig
Desde roxygen2 6.0.0 puede utilizar el descuento directamente en la documentación de su R.
#' @details text describing parameter inputs in more detail.
#' * parameter 1 stuff
#' * parameter 2 stuff
#' @md
Para utilizar esta incluye ni Roxygen: list(markdown = TRUE) en su descripción a su vez de rebajas durante todo el paquete o añadir la etiqueta @md en un solo archivo.
Documentación: [Documentación de Write R en Markdown] (https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html#lists) por Gábor Csárdi. "Tenga en cuenta que no tiene que dejar una línea vacía antes de la lista. Esto es diferente de algunos analizadores de rebajas". –
do '\ describe {}', '\ itemize {}' como en el trabajo del manual de extensiones R ...? –
@Ben sí lo hacen – hadley