2015-01-28 15 views
7

Tôi đang làm việc để ghi lại chức năng trực quan hóa trong một gói của tôi. Với mục đích này, tôi muốn có một hình ảnh được nhúng thông qua tập tin Rd 'funcname.Rd' có thể giải thích các tham số khác nhau được sử dụng trong hàm, và nó sẽ xuất hiện nếu người dùng đọc PDF hướng dẫn sử dụng hoặc viết 'funcname 'trong R. Một cái gì đó trong dòng:Bao gồm hình ảnh trong tập tin tài liệu R-package (.Rd)

Manual example

' Viết R extensions'-tài liệu dường như không giải quyết vấn đề này, và các tài liệu tham khảo duy nhất tôi có thể tìm được this blog postthis R-devel discussion. Trước đây có một liên kết bị hỏng đến một gói được gọi là 'base64' và sau đó chỉ giải quyết các lựa chọn thay thế khác nhau, bao gồm cả hình ảnh trong phần tử gói R thay thế. Nó sẽ là tuyệt vời nếu điều này có thể tương thích với CRAN.

Bất kỳ lời khuyên nào về cách tiếp cận vấn đề này sẽ được đánh giá cao, cảm ơn!

+1

Bạn phải xử lý tệp Rd của mình thành văn bản thuần túy. Tôi có thể muốn bao gồm mã sản xuất một con số như vậy trong các ví dụ. – Roland

+0

Đây là khoảng một trong những công việc mà họ đã đề xuất trong cuộc thảo luận R-devel; dường như sử dụng 'example (funcname)' là thứ mà mọi người đã sử dụng. Điều với số liệu do R sản xuất là tôi muốn có một số dòng cách điệu, dấu ngoặc nhọn, v.v. trong hình để chỉ ra các tham số khác nhau đã làm, và làm điều này chỉ trong R có thể khá bất tiện. Nhưng bạn là chính xác. –

+2

Chỉ cần lưu ý rằng một số (nhiều?) Người dùng sẽ không nhìn thấy hình. Ví dụ: nếu chúng hoạt động từ một dòng lệnh. – Roland

Trả lời

10

chưa được kiểm tra, nhưng nhìn vào nguồn R trên GitHub, nó sẽ xuất hiện họ thêm một hình ảnh để ?par documentation file theo cách thức sau đây:

\item{\code{mai}}{A numerical vector of the form \code{c(bottom, 
     left, top, right)} which gives the margin size specified in 
     inches.\cr 
     \if{html}{\figure{mai.png}{options: width="35\%" alt="Figure: mai.png"}} 
     \if{latex}{\figure{mai.pdf}{options: width=7cm}} 
    } 

Con số này dường như được lưu trong /man/figures.

+0

Cảm ơn! Tôi sẽ kiểm tra. –

+1

Điều này có vẻ là tại thời điểm tốt nhất, câu trả lời được chấp nhận. Vì mục đích của tôi, nó hoạt động tốt, nhưng như Roland đã chỉ ra trong các bình luận của anh ta ở trên, người ta không nên mong đợi tất cả người dùng nhìn thấy các con số. –

+2

Chỉ cần một FYI cho bất cứ ai xảy ra khi câu hỏi này trong tương lai. Cú pháp được chỉ định ở trên hoạt động tốt! – schifferl

Các vấn đề liên quan