Sử dụng tài liệu roxygen2 với devtools document
chức năng tự động tạo trường Collate:
trong gói DESCRIPTION, bất kể có cần tải các tệp thư viện gói theo một thứ tự cụ thể hay không.Làm cách nào để chỉ ra thứ tự đối chiếu trong Roxygen2?
Tôi đang làm việc trên một gói với một loạt các phương pháp S4 và muốn chắc chắn các định nghĩa lớp được tải trước bất kỳ phương pháp hoặc các lớp khác sử dụng chúng, mà tôi hiểu tôi có thể làm với danh sách Collate
, nhưng tôi ' m không chắc chắn làm thế nào để chỉ ra điều này trong định dạng tài liệu roxygen2.
roxygen2 manual làm cho một số tham chiếu đến thẻ @include
nhưng có vẻ như thực sự chỉ bao gồm mã trong tài liệu, ví dụ: để thêm ví dụ bên ngoài thông qua cờ @examples
. Điều này có thể được sử dụng để chỉ định thứ tự đối chiếu cho các phương thức không?
Nếu đối chiếu trường đã có trong MÔ TẢ roxygen2 không tạo ra nó. Vì vậy, tôi muốn nói rằng bạn phải thực hiện theo thứ tự bạn muốn và cần được tôn trọng. (Tôi nghĩ vậy, vì vậy nhận xét so với câu trả lời). –
nó sẽ là tốt đẹp để biết nếu giải thích @import của tôi là chính xác. Nó cũng chắc chắn sẽ là tốt đẹp để có một con số chức năng ra lệnh collate từ một danh sách các phụ thuộc tập tin hơn là phải làm việc nó ra bằng tay. Nhập khẩu – cboettig
được sử dụng để nhập gói. Điều này tương tự như việc liệt kê một gói trong phần Phụ thuộc, ngoại trừ việc nó sạch hơn nhiều vì nó không gây ô nhiễm không gian tên của người dùng. – Dason