Làm cách nào để thêm tệp Changelog hoặc NEWS vào gói R của tôi?

Question

Tôi có một gói trên CRAN mà tôi muốn thêm ChangeLog cho, nhưng tôi không thể tìm thấy thông tin ở bất cứ đâu về cách thực hiện việc này.

Tôi đã xem tài liệu "Viết R Extensions" mà CRAN cung cấp, nhưng nó chỉ đề cập đến ChangeLogs và không đưa ra hướng nào (tôi có thể tìm) về cách tạo một tài liệu.

Tôi nhận thấy việc tải xuống tarball từ các gói khác trên CRAN (ví dụ: seacarb) rằng ChangeLogs của chúng là Tệp thực thi Unix (Tôi đang sử dụng Mac) nên không hữu ích lắm.

tôi tưởng tượng đây là một vấn đề phổ biến, nhưng Googling "changelog R package" chỉ sẽ trả về ghi thay đổi đối với các gói thực sự phổ biến ...

Answer 1

Bạn có thể cung cấp một tập tin NEWS hoặc một tập tin ChangeLog, hoặc cả hai, để mô tả những thay đổi trong bạn gói. Bạn phải thêm các tệp này vào thư mục cấp cao nhất của dự án, tức là trong cùng một thư mục với số DESCRIPTION và NAMESPACE.

Điều này được ghi lại trong R package manual trong đoạn 1.1 Package structure. Cụ thể, đoạn này trỏ tới tiêu chuẩn GNU:

Đối với các quy ước cho tệp Tin tức và thay đổiĐăng nhập GNU xem http://www.gnu.org/prep/standards/standards.html#Documentation.

---

Hadley chỉ ra rằng "Nói chung, bạn nên sử dụng một tập tin NEWS, và không ChangeLog. Tôi nghĩ rằng mục đích của ChangeLog (liệt kê mọi thay đổi), đã được gộp bằng cách điều khiển mã nguồn".

---

Để tạo một tập tin NEWS, chỉ cần tạo một file văn bản được gọi là NEWS trong thư mục cấp cao nhất của gói của bạn. Bạn duy trì tệp này bằng tay.

Dưới đây là một đoạn trích từ tập tin NEWS từ gói của tôi miniCRAN (CRAN link):

miniCRAN v0.0-21 (Release date: 2014-08-18) 
============== 

Changes: 

* Changes to defaults in plot.pkgDepGraph() to move legend to left of plot area. 

miniCRAN v0.0-20 (Release date: 2014-08-18) 
============== 

Changes: 

* Modified examples to reduce running time, mostly using \dontrun{} sections