2013-06-12 9 views
7

Ich verwende roxygen2 aus RStudio, um Paketdokumentation zu generieren. Wie erzwinge ich Folgendes im @ Description-Abschnitt als verbatim fixed-font angezeigt?Verbatim Ausgabe in roxygen2 Paketdokumentation

SettingID Value  
RedItem  Patient_10574  
GreenItem Record_433  

Meine Abhilfe ist es in @examples \ dontrun setzen {}, aber das ist nicht das, was ich will.

@Joshua Ulrich fand eine (Nicht-) Lösung here

+0

Nur eine Idee, was ist '\ code {}'? Kann es mit mehreren Zeilen umgehen? –

+0

Offensichtlich war '\ code {}' meine erste Wahl, aber ich konnte es nicht erreichen, das wörtliche Layout zu ehren. Ich dachte, ich könnte '\ dontrun {}' verwenden, aber das wird außerhalb @examples nicht akzeptiert. Vielleicht habe ich einen Trick verpasst, aber ich habe ein paar "Newline" Varianten ausprobiert. –

+1

Dies kann das gleiche Problem sein, auf das ich [hier] stieß (http://stackoverflow.com/q/14041601/271616). –

Antwort

2

UPDATE: Wrapping wird nun standardmäßig in roxygen2 ausgeschaltet, so sollte dies kein Problem mehr sein.

Ich habe einen neuen Kommentar Syntax für roxygen2 erfunden, die Verpackung erhalten wird: Kommentare beginnend mit

#'' 

sind überhaupt nicht umgebrochen. Mein reference implementation hat received much attention noch nicht, obwohl ...

Natürlich turning off wrapping altogether ist auch ein Weg, um das Problem zu umgehen, aber ich frage mich, wie die Hilfe wie in einem Kommandozeilen-Terminal aussieht, wenn der Entwickler vergisst, sie zu wickeln roxygen Kommentare ... Es muss einen Grund gegeben haben, warum Wrapping überhaupt eingeführt wurde.

+0

Großartig. Weißt du, ob das auf RStudio etc. übertragen wird? Ich kenne die genaue Befehlskette nicht, um es zum Laufen zu bringen. –

+0

@DieterMenne: Installieren Sie von meinem Feature Zweig mit 'install_github ('roxygen', 'krmlrr', ref = '80 -preformatted') und sehen, ob es für Sie funktioniert. Mit "install.package" oder "install_github" ('roxygen', 'klutometis') 'kann man immer zu" original "roxygen2 zurückkehren. – krlmlr

+0

Änderung funktioniert für mich –