2010-02-23 52 views
9

我剛剛開始使用roxygen軟件包,我對目前的結果非常滿意。然而,我想知道,有沒有辦法指定roxygen它應該忽略某些不能用戶訪問的函數?Roxygen可以忽略非用戶功能嗎?

具體而言,我寧願沒有.Rd文件彈出,因爲我在我的包中使用了.onLoad()鉤子。此功能已在base包中記錄,因此我沒有理由重新記錄它。

回答

14

嗯,我終於找到並瀏覽了Roxygen-devel列表R-forge,看看它何時會實現,它似乎已經在CRAN上的Roxygen版本中。關鍵是在致電roxygenize()時指定use.Rd2=TRUE。在此模式下,Roxygen將跳過爲Roxygen評論之前未提供的任何功能創建文檔。

+1

+1感謝您的關注。 – Shane 2010-02-23 18:25:30

+3

在roxygen2中,即使您有roxygen2文檔,您也可以使用'@ noRd'來禁止在Rd文件上創建。 – hadley 2014-03-23 23:10:18

2

這是在他們的待辦事項列表中 - 在下一個版本中,只有具有roxygen文檔的功能纔會創建man文件。

相關問題