Output verbatim nella documentazione del pacchetto roxygen2

Sto utilizzando roxygen2 da RStudio per generare la documentazione del pacchetto. Come faccio a forzare quanto segue nella sezione @description ad apparire come carattere fisso letterale?Output verbatim nella documentazione del pacchetto roxygen2

SettingID Value  
RedItem  Patient_10574  
GreenItem Record_433

La mia soluzione è quella di metterla in @examples \ dontrun {}, ma non è questo quello che voglio.

@Joshua Ulrich trovato una soluzione (non) per here

fonte

2013-06-12 Dieter Menne

Solo un'idea, per quanto riguarda '\ code {}'? Può gestire più linee? –

Chiaramente, '\ code {}' era la mia prima scelta, ma non riuscivo a far rispettare il layout testuale. Pensavo di poter usare '\ dontrun {}', ma quello non è accettato al di fuori di @examples. Forse mi sono perso qualche trucco, ma ho provato alcune varianti "newline". –

Questo potrebbe essere lo stesso problema in cui mi sono imbattuto in [here] (http://stackoverflow.com/q/14041601/271616). –

UPDATE: Wrapping è ora disattivato per impostazione predefinita in roxygen2, quindi questo non dovrebbe essere più un problema.

ho inventato un nuovo commento sintassi per roxygen2 che preserverà avvolgimento: Commenti a cominciare

#''

non sono avvolti a tutti. Il mio reference implementation non ha received much attention ancora, però ...

Naturalmente, turning off wrapping altogether è anche un modo per gestire il problema, ma mi chiedo come l'aiuto si presenta come in un terminale a riga di comando, se lo sviluppatore dimentica di avvolgere la sua commenti sul roxygen ... Deve esserci stato un motivo per cui il wrapping è stato introdotto in primo luogo.

fonte

2013-07-15 13:10:07 krlmlr

Grande. Sai se questo verrà trasferito a RStudio ecc.? Non conosco l'esatta catena di comando per farlo funzionare. –

@DieterMenne: Installa dal mio ramo di funzione usando 'install_github ('roxygen', 'krlmlr', ref = '80 -preformatted ')' e vedi se funziona per te. Puoi sempre tornare a "original" roxygen2 con 'install.package' o' install_github ('roxygen', 'klutometis') '. – krlmlr

La modifica funziona per me –

Output verbatim nella documentazione del pacchetto roxygen2

risposta

Problemi correlati