Loại trừ chức năng khỏi hướng dẫn gói R

Question

Tôi đang viết một gói R và tôi đang ghi lại tất cả các chức năng của mình bằng roxygen2. Tuy nhiên, tôi không muốn tất cả các chức năng xuất hiện trong hướng dẫn sử dụng của gói. Làm cách nào tôi có thể chỉ định các chức năng nào sẽ xuất hiện trong hướng dẫn sử dụng gói, hoặc những chức năng nào sẽ không xuất hiện?

Tôi biết rằng đặt tên cho hàm có dấu chấm đứng đầu, ví dụ: .f <- function() thay vì f <- function() là một giải pháp. Có giải pháp nào khác không?

Answer 1

Tôi đã bỏ lỡ các chi tiết sau đây trong cuốn sách tuyệt vời R packages bởi Hadley Wickham (trong phần nói về tài liệu hướng dẫn đối tượng):

@keywords TỪKHÓA1 TỪKHÓA2 ... thêm từ khóa được chuẩn hóa. Từ khóa là tùy chọn, nhưng nếu có, phải được lấy từ danh sách được xác định trước được tìm thấy trong tệp.path (R.home ("doc"), "TỪ KHÓA").

Nói chung, từ khóa không hữu ích ngoại trừ @keywords nội bộ. Sử dụng từ khóa nội bộ sẽ xóa chức năng khỏi chỉ mục gói và vô hiệu hóa một số thử nghiệm tự động của chúng. Thông thường sử dụng @keywords nội bộ cho các chức năng mà các nhà phát triển khác đang quan tâm mở rộng gói của bạn, nhưng không phải hầu hết người dùng.

Vì vậy, thêm @keywords internal vào tài liệu hàm roxygen2 dẫn đến chức năng không xuất hiện trong hướng dẫn gói/chỉ mục, trong khi vẫn làm cho trang trợ giúp có thể truy cập được sau khi tải gói.