2010-02-23 1 views
9

방금 ​​roxygen 패키지를 가지고 놀기 시작 했으므로 지금까지의 결과에 매우 만족합니다. 그러나 궁금 해서요, 거기에 사용자가 액세스 할 수없는 특정 기능을 무시해야 roxygen 지정하는 방법이 무엇입니까?Roxygen은 비 사용자 기능을 무시할 수 있습니까?

특히, 내 패키지에 .onLoad() 훅을 사용하고 있기 때문에 구체적으로는 .Rd 파일 팝업이 표시되지 않습니다. 이 기능은 이미 base 패키지에 문서화되어 있으므로 다시 문서화 할 이유가 없습니다.

답변

14

음, 드디어 R-forge에있는 Roxygen-devel 목록을 찾아서 살펴 보았습니다. 이것이 언제 구현되는지 알고 있으며 이미 CRAN에있는 Roxygen의 버전에있는 것으로 보입니다. 열쇠는 roxygenize()을 호출 할 때 use.Rd2=TRUE을 지정하는 것입니다. 이 모드에서는 Roxygen이 Roxygen 주석이없는 모든 함수에 대한 문서 작성을 건너 뜁니다.

+1

+1 다음 사항을 알려 주셔서 감사합니다. – Shane

+3

roxygen2에서는 roxygen2 문서가 있어도'@ noRd'를 사용하여 Rd 파일 생성을 억제 할 수 있습니다. – hadley

2

다음 목록에서 - 다음 버전에서는 roxygen 문서의 기능 만이 man 파일을 생성합니다.