Qual è la sintassi appropriata per aggiungere un elenco dettagliato a roxygen2, ad esempio, nella sezione @dettagli? Posso creare un ambiente di lista di lattice?Quando si documenta in Roxygen: Come posso creare un elenco dettagliato in @details?
sembra che le interruzioni di linea vengono semplicemente ignorati, vale a dire
#' @details text describing parameter inputs in more detail
#'
#' parameter 1: stuff
#'
#' parameter 2: stuff
grazie!
Ecco un esempio di roxygen2 che segue la formulazione del problema.
##'
##' @details text describing parameter inputs in more detail.
##' \itemize{
##' \item{"parameter 1"}{Stuff}
##' \item{"parameter 2"}{Stuff}
##' }
##'
Ciò consentirà di utilizzare la sezione articolo nella sezione dettagli. Puoi anche usarlo nelle sezioni @param.
Spero che questo aiuti.
Puoi indicarmi la documentazione in cui hai trovato questo? Sto avendo difficoltà a capire la sintassi per alcune delle funzionalità Latex in Roxygen. –
@JeffAllen Ho appena visionato la sezione http://cran.r-project.org/doc/manuals/R-exts.html#Lists-and-tables del manuale "Writing R Extensions" e l'ho provata in Roxygen, che funziona bene per me. C'è un problema specifico che stai avendo? –
@JeffAllen Si noti che questo è lo stile R doc (.Rd) standard per gli elenchi, che è solo lo stile LaTeX. Problemi con sia roxygen che .Rd è che può essere difficile prevedere quando qualcosa che funziona in tex funzionerà in .Rd, e quando ciò che funziona in .Rd funzionerà in roxygen ... – cboettig
Poiché roxygen2 6.0.0 è possibile utilizzare il markdown direttamente nella documentazione R.
#' @details text describing parameter inputs in more detail.
#' * parameter 1 stuff
#' * parameter 2 stuff
#' @md
Per utilizzare questo includono sia Roxygen: list(markdown = TRUE) nella descrizione di trasformare Markdown su per l'intero pacchetto o aggiungere il tag @md in un unico file.
Documentazione: [Scrivi documentazione R in Markdown] (https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html#lists) di Gábor Csárdi. "Nota che non hai lasciato una riga vuota prima dell'elenco, questo è diverso da alcuni parser di markdown." –
do '\ describe {}', '\ itemize {}' come nel manuale del manuale delle estensioni R ...? –
@ Ben sì – hadley