Sử dụng họa tiết PDF tĩnh (sẵn có) trong gói R

Question

Cách thích hợp để bao gồm tệp PDF tĩnh dưới dạng "họa tiết" trong gói CRAN là R 3.0?

Bí quyết được mô tả trong this document khi sử dụng dấu trang trống Rnw dường như không hoạt động trong R 3.0. Tài liệu cho thấy rằng bây giờ có một cách tốt hơn dựa trên \VignetteEngine{} nhưng nó không phải là khá rõ ràng như thế nào điều này làm việc cho các tập tin PDF tĩnh.

Answer 1

Với R.rsp (> = 1.19.0), bạn có thể bao gồm một PDF tĩnh 'họa tiết/main.pdf' bằng cách thêm một 'họa tiết/main.pdf.asis' tập tin văn bản nhỏ chứa :

%\VignetteIndexEntry{My amazing package} 
%\VignetteEngine{R.rsp::asis} 

và chắc chắn phải có:

Suggests: R.rsp 
VignetteBuilder: R.rsp 

trong tập tin MÔ tẢ của gói của bạn. Điều này cũng hoạt động đối với các họa tiết HTML tĩnh. Điều này cũng được giải thích ở một trong các họa tiết R.rsp.

Answer 2

CẬP NHẬT 2014-06-08: Để có giải pháp tốt hơn để bao gồm tệp PDF tĩnh và HTML trong gói R, hãy xem câu trả lời khác của tôi về cách sử dụng R.rsp (> = 0.19.0) và R.rsp::asis họa tiết họa tiết.

Tất cả những gì bạn cần là tệp <name>.Rnw có tên khớp với tệp <name>.pdf tĩnh của bạn, ví dụ:

vignettes/ 
    static.pdf 
    static.Rnw 

nơi <name>.Rnw (ở đây static.Rnw) là một tập tin Sweave hợp lệ tối thiểu, ví dụ

%\VignetteIndexEntry{<title to be displayed on the R vignette index page>} 
\documentclass{article} 
\begin{document} 
\end{document} 

file nguồn họa tiết này (<name>.Rnw) thủ đoạn R CMD build để xây dựng nó, ví dụ: R của tools::buildVignettes() đầu tiên sẽ Sweave <name>.Rnw vào <name>.tex như bình thường. Tuy nhiên, do cách buildVignettes() được thiết kế, nó sẽ phát hiện tệp tĩnh <name>.pdf của chúng tôi đã được tạo bởi công cụ Sweave và do đó nó sẽ không biên dịch tệp TeX giả này thành tệp PDF (tệp này sẽ ghi đè tệp tĩnh của chúng tôi).

Điều quan trọng cần hiểu là (i) họa tiết "đang xây dựng" trong R CMD build, (ii) và khi chúng được sao chép vào thư mục inst/doc/ (được tạo nếu thiếu) của gói được tạo. Ngoài ra, (iii) thư mục vignettes/ sẽ không là một phần của gói xây dựng, tức là <pkgname>_<version>.tar.gz tệp. Vì vậy, hãy đảm bảo xem trong inst/doc/.

Vì vậy, phải rõ ràng ở đây, sử dụng giả <name>.Rnw có thể được coi là một hack có thể phá vỡ nếu ai đó quyết định ngăn chặn chiến lược này. Tuy nhiên, nếu điều đó xảy ra, bạn hoàn toàn có thể tạo ra một công cụ họa tiết không Sweave mà mục đích duy nhất là biên dịch một tệp <name>.pdf thành một tệp ... <name>.pdf. Điều này là hợp lệ và có thể do sự hỗ trợ không Sweave được thêm vào trong R (> = 3.0.0). Tôi đã cân nhắc việc thêm công cụ như vậy vào gói R.rsp, ví dụ: \ VignetteEngine {R.rsp :: StaticPDF}. Với điều đó bạn thậm chí sẽ không phải có tệp Rnw giả đó - chỉ có tệp PDF.

Hope this helps