Một số R gói phần (ví dụ: ggplot2, dplyr, devtools vv) đã theo thứ tự abc quyền để giúp họ/tài liệu và quầy bar của các liên kết đến các phần (thể hiện bằng mũi tên đỏ trong hình dưới đây). Các gói khác (ví dụ: RcmdrMisc) không có.Thêm phần để R gói của help/tài liệu
Làm cách nào để thêm các yếu tố này vào số R trợ giúp của gói?
tôi sử dụng roxygen2 cho tài liệu.
Trong R Extensions tập tin văn bản (bao gồm tất cả các bản sao của R từ cran) là một phần nhỏ liên quan đến các tập tin INDEX:
1.1.4 Các tập tin INDEX
File INDEX tùy chọn chứa một dòng cho mỗi đối tượng đủ thú vị trong gói, đặt tên và mô tả của nó (các chức năng như phương thức in thường không được gọi rõ ràng có thể không được bao gồm). Thông thường tệp này bị thiếu và thông tin tương ứng được tạo tự động từ nguồn tài liệu (sử dụng
tools::Rdindex()) khi cài đặt từ nguồn.
Khi gói có tệp chỉ mục, mã HTML nằm trong thư mục html.
Tôi thấy rằng thư mục 'html' trong phiên bản đã cài đặt của gói của tôi, nhưng tôi vẫn không hiểu, cách tạo các phần. Hàm 'tools :: Rdindex()' có trách nhiệm tạo tệp HTML với chỉ mục trong khi cài đặt gói không? – Vilmantas
Đó là sự hiểu biết của tôi về quá trình thông thường. Tự động. –
Câu hỏi hay! Tôi đoán mã nguồn của các gói có thể đưa ra một câu trả lời (nếu không ai ở đây biết điều đó). –
Theo như tôi biết, các tệp chỉ mục này được tạo tự động. Ít nhất, các gói của tôi luôn có chúng, nhưng tôi không bao giờ viết chúng. Tôi luôn nghĩ rằng những chữ cái này được thêm vào tự động, khi danh sách các chức năng đủ dài. Nhưng tôi có thể sai. – Stibu
Tôi đã nghiên cứu cấu trúc của một vài gói trên GitHub, nhưng không tìm ra cách tạo chỉ mục theo thứ tự bảng chữ cái đó. – Vilmantas