2010-02-23 11 views
9

roxygen paketi ile oynamaya başladım ve şimdiye kadarki sonuçlardan çok memnun kaldım. Ancak merak ettim, roxygen için kullanıcı tarafından erişilemeyen bazı işlevleri göz ardı etmemesi gereken bir yol var mı?Can Roxygen kullanıcı dışı işlevleri dikkate almıyor mu?

Paketimdeki .onLoad() kanca kullanıyorum çünkü özellikle, bir .Rd dosya pop var değil. Bu işlev zaten base paketinde belgelenmiştir, bu yüzden yeniden belgelememe gerek yok.

cevap

14

Nihayet, bunun ne zaman uygulanacağını görmek için R-forge adresindeki Roxygen-devel listesini bulup gezdim ve zaten CRAN üzerindeki Roxygen sürümünde olduğu görülüyor. Anahtar, roxygenize() numaralı telefonu ararken use.Rd2=TRUE belirtmektir. Bu modda, Roxygen, Roxygen yorumlarının önceliği olmayan tüm işlevler için belge oluşturmayı atlayacaktır.

+1

+1 Bunu takip ettiğiniz için teşekkür ederiz. – Shane

+3

Roxygen2'de, roxygen2 belgeleriniz olsa bile Rd dosyalarındaki oluşturmayı bastırmak için '@ noRd' kullanabilirsiniz. – hadley

2

Bu, yapılacaklar listesinde - bir sonraki versiyonda, sadece roxy dokümantasyonu ile çalışan fonksiyonlar insan dosyaları oluşturacaktır.

İlgili konular