2013-06-12 11 views
7

Używam roxygen2 z poziomu RStudio do generowania dokumentacji pakietu. Jak wymusić następujące czynności w sekcji @description, aby pojawiły się jako wierna czcionka o stałej długości?Dosłowne wyjście w dokumentacji pakietu roxygen2

SettingID Value  
RedItem  Patient_10574  
GreenItem Record_433  

Moje obejście polega na wstawieniu go do @przykładów \ dontrun {}, ale nie tego chcę.

@Joshua Ulrich znalazł rozwiązanie (nie) do here

+0

Tylko pomysł, a co z '\ code {}'? Czy poradzi sobie z wieloma liniami? –

+0

Najwyraźniej "\ code {}" było moim pierwszym wyborem, ale nie mogłem go zdobyć, by uszanować dosłowną szatę graficzną. Myślałem, że mogę użyć '\ dontrun {}', ale ten nie jest akceptowany poza @przykładami. Może przegapiłem jakąś sztuczkę, ale spróbowałem kilku wariantów "nowej linii". –

+1

To może być ten sam problem, na który natrafiłem [tutaj] (http://stackoverflow.com/q/14041601/271616). –

Odpowiedz

2

UPDATE: owijarki jest teraz domyślnie wyłączona w roxygen2, więc nie powinno to być problemem już.

ja wynaleźli nowy komentarz składnię roxygen2 który zachowa Opakowanie: Komentarze zaczynając

#'' 

nie są owinięte w ogóle. My reference implementation nie ma received much attention jeszcze, choć ...

Oczywiście turning off wrapping altogether to również sposób poradzić sobie z problemem, ale zastanawiam się, jak wygląda pomoc w terminalu wiersza polecenia jeśli deweloper zapomni ją owinąć komentarze roxygen ... Musiał być powód, dla którego wprowadzono owijanie.

+0

Świetnie. Czy wiesz, czy przeniesie to do RStudio itp.? Nie znam dokładnego łańcucha dowodzenia, żeby to zadziałało. –

+0

@DieterMenne: Zainstaluj z mojej gałęzi funkcji, używając 'install_github ('roxygen', 'krlmlr', ref = '80 -preformatted ')' i sprawdź, czy to działa. Zawsze możesz wrócić do "oryginalnego" roxygen2 z 'install.package' lub' install_github ('roxygen', 'klutometis') '. – krlmlr

+0

Modyfikacja działa dla mnie –