2013-06-12 21 views
7

我使用RStudio中的roxygen2生成軟件包文檔。如何強制@description部分中的以下內容顯示爲逐字固定字體?roxygen2軟件包文檔中的逐字輸出

SettingID Value  
RedItem  Patient_10574  
GreenItem Record_433  

我的解決方法是將它放到@examples \ dontrun {}中,但那不是我想要的。

@Joshua烏爾裏希發現了一個(非)解決方案here

+0

只是一個想法,'\ code {}'怎麼辦?它可以處理多行嗎? –

+0

顯然,'\ code {}'是我的第一選擇,但我無法得到它遵守逐字佈局。我以爲我可以使用'\ dontrun {}',但是@examples之外不接受這個。也許我錯過了一些技巧,但我嘗試了一些「換行」變體。 –

+1

這可能是我碰到的同一個問題[這裏](http://stackoverflow.com/q/14041601/271616)。 –

回答

2

UPDATE:包皮現在是默認roxygen2關閉的,所以這不應該是一個問題了。

我發明了一種新的註釋語法roxygen2將保留包裝:註釋以

#'' 

開始都不會換。我reference implementation還沒有received much attention的是,雖然...

當然,turning off wrapping altogether也是處理問題的方式,但我不知道該如何幫助看上去像在命令行終端如果開發商忘了她的包roxygen的評論...首先介紹包裝的原因一定是有原因的。

+0

太好了。你知道這是否會傳遞給RStudio等?我不知道確切的命令鏈來使它工作。 –

+0

@DieterMenne:使用'install_github('roxygen','krlmlr',ref = '80 -preformatted')從我的特性分支安裝,看看它是否適合你。您可以隨時使用'install.package'或'install_github('roxygen','klutometis')'回到「原始」roxygen2。 – krlmlr

+0

修改適合我 –