2010-02-23 28 views
9

Tôi vừa bắt đầu chơi với gói roxygen và tôi đã rất hài lòng với kết quả cho đến nay. Tuy nhiên tôi đã tự hỏi, là có một cách để xác định để roxygen rằng nó nên bỏ qua một số chức năng mà không phải là người dùng có thể truy cập?Roxygen có thể bỏ qua các chức năng không sử dụng không?

Cụ thể, tôi không muốn có tệp .Rd bật lên vì tôi đang sử dụng móc .onLoad() trong gói của mình. Chức năng này đã được ghi lại trong gói base do đó không có lý do gì để tôi phải ghi lại nó.

Trả lời

14

Vâng, cuối cùng tôi đã tìm thấy và duyệt danh sách Roxygen-devel tại R-forge để xem thời điểm này sẽ được triển khai và dường như đã có trong phiên bản Roxygen có trên CRAN. Điều quan trọng là chỉ định use.Rd2=TRUE khi gọi số roxygenize(). Theo chế độ này, Roxygen sẽ bỏ qua việc tạo tài liệu cho bất kỳ chức năng nào không có trong các bình luận của Roxygen.

+1

+1 Cảm ơn bạn đã theo dõi điều đó. – Shane

+3

Trong roxygen2, bạn cũng có thể sử dụng '@ noRd' để ngăn chặn việc tạo trên các tệp Rd ngay cả khi bạn có tài liệu roxygen2. – hadley

2

Đây là danh sách việc cần làm - trong phiên bản tiếp theo, chỉ các chức năng với tài liệu roxygen mới tạo được tệp người.

Các vấn đề liên quan