2011-07-27 47 views
2

由於最初運行package.skeleton來創建一個包,我添加了幾個S3類。每個類都有5-10個方法。我發現了一個美妙的prompt命令,用於從加載到內存中的函數創建.Rd文件,但是是否可以讓R自動創建一個包含所有多個功能的幫助文件?我正在考慮類似prompt的增強版本,您可以在其中傳遞一個函數列表,並且它將創建一個.Rd文件,其中只有附加信息添加到幫助文件中。在一個文件中自動記錄多個S3方法

舉例來說,如果我有一個通用名爲duration,且有一些方法duration.bond(market,...)duration.account(market,time,...)duration.portfolio(market,...)班,我想prompt創建一個幫助文件包含每個\method{}一個\usage部分和含market\arguments{}部分, \dotstime

這裏有什麼希望嗎?複製和粘貼變得非常累人!

+0

bond(),account(),...對我來說看起來像方法/函數,而不是類。如果他們是班級,你的問題是相當混亂... –

+0

他們是創建一個特定類的對象的函數。所以持續時間是通用的,我有duration.bond,duration.account,duration.portfolio方法/函數。但你說得對,第二段很混亂。去重新說話。 –

+0

Roman指出的一種可能性就是使用ROxygen。我可能會爲未來的項目做到這一點,但對於這個項目......權宜之計就是選擇參數最多的方法,並使用'prompt'。但不是最優雅的方法。 –

回答

1

爲了完整性,我在這裏選擇添加的內容是選擇參數最多的方法並使用提示符,然後將其他方法手動添加到同一個幫助文件中。

另一種選擇是使用Rd2roxygen將已經在.Rd中的所有內容轉換回Roxygen,然後在整個項目中使用Roxygen。這可能是我在下一個版本中所做的。

0

你可以滾你自己通過閱讀在模板的幫助文件(readLines),然後修改以適合每個特定情況下(明智地使用pastegsub),然後將結果寫到背出到文件(通過writeLines)。

+0

這是不夠的痛苦滾動自己的。我很驚訝它不在那裏。 –

相關問題