2015-05-25 19 views
5

Mi chiedo se è possibile inserire newline all'interno dei blocchi di codice in roxygen2 quando si documenta una funzione?È possibile utilizzare newline all'interno del blocco di codice roxygen2?

Se ho qualcosa all'interno di \code{}, roxygen2 comprime tutte le nuove righe in spazi singoli per impostazione predefinita. Ho provato ad inserire \cr all'interno per forzare un'interruzione di riga, e ottengo il comportamento desiderato, ma poi ricevo un messaggio di avvertimento quando "R CMD CHECK". C'è un modo per fare questo?

Esempio:

#' \code{ 
#' multiple 
#' lines 
#' } 
+0

Si noti che questo non è davvero un problema di roxygen ma piuttosto un problema di documentazione generale R, consultare [il manuale] (http://cran.r-project.org/doc/manuals/r-release/R-exts. html # Marcatura-text). – Backlin

risposta

9

Uso \preformatted invece di \code. \code è per codice inline (funziona come `` su SO) e \preformatted è per blocchi verbatim (come indentazione su SO).

#' \preformatted{ 
#' multiple 
#' lines 
#' } 

Si noti che l'interruzione di riga iniziale, subito dopo {, sarà anche parte del blocco di codice, per cui si potrebbe prendere in considerazione la rimozione.