Tôi đang trong quá trình ghi lại một số chức năng của mình cho một gói R mà tôi đang thực hiện.Làm thế nào để tham chiếu chéo một phương trình trong một tập tin trợ giúp R / roxygen2
Tôi đang sử dụng đánh dấu roxygen, mặc dù điều đó phần lớn không liên quan đến câu hỏi của tôi.
Tôi đã đặt phương trình vào tài liệu của mình bằng cách sử dụng \deqn{...}
. Câu hỏi của tôi là: Có cách nào để tham khảo chéo phương trình này sau này không?
Ví dụ, trong tập tin Rd tôi:
\deqn{\label{test}
y = mx + b
}
Tôi có thể sau đó làm điều gì đó như:
Đề cập đến phương trình \ ref {} kiểm tra, ...
Tôi đã thử \eqref{test}
, \ref{test}
(cả hai đều nhận được "macro không xác định" và không được liên kết) và cũng có thể \link{test}
(trong đó comp lains nó không thể tìm thấy chức năng test
bởi vì nó thực sự chỉ để liên kết với các chức năng khác).
Nếu không tôi sợ tôi có thể phải làm một cái gì đó hacky và thêm trong -- (1)
và Refer to equation (1)
tay trong \deqn
vv trong file Rd ...
Cập nhật
câu trả lời chung dường như là " Không". (awww ...)
Tuy nhiên, tôi có thể viết họa tiết và sử dụng gói latex/bình thường "" ở đó. Trong mọi trường hợp, tôi đã chỉ nhận thấy rằng các phương trình ma trận tôi đã dành lứa tuổi đưa vào roxygen/Rd tập tin của tôi trông khủng khiếp trong phiên bản ?myFunction
của sự giúp đỡ (chúng hiển thị như là chỉ về nguồn latex cao). Đó là một sự xấu hổ, bởi vì họ trông đẹp trong phiên bản pdf của sự giúp đỡ.
@Iterator đã chỉ ra sự tồn tại của conditional text, vì vậy tôi sẽ thực hiện các phép toán ASCII trong tệp .Rd, nhưng tính toán Latex trong hướng dẫn sử dụng pdf/họa tiết.
Câu hỏi thú vị và thực sự, việc tham chiếu phương trình #s là không bền vững. Cho rằng định dạng '.Rd' chỉ là LaTeX cơ bản nhất, và không hỗ trợ phần mở rộng AMS, tôi không chắc liệu điều này có khả thi hay không. Nó có thể là bạn phải sử dụng một họa tiết cho nó. – Iterator
Tại thời điểm này tôi có một loạt các "Trong phương trình trên ..." "Trong phương trình ma trận lớn ..." - đó là một chút khó xử! (Tôi không có quá nhiều phương trình cho mỗi tập tin Rd mặc dù - tôi có thể thấp hơn bản thân mình để hack một "- (1)" vào 'deqn' và sau đó chỉ cần nói" Tham khảo phương trình 1 "trong văn bản .. nhưng nó cảm thấy rất sai!) –
Có lẽ một họa tiết là một cách tốt hơn để đi? Tôi chưa quen thuộc với định dạng .Rd, nhưng tôi không đặc biệt bị thu hút bởi một định dạng tài liệu dường như là một tập hợp con của LaTeX. Câu hỏi của bạn là tốt, nhưng, IMO, đó là bởi vì nó chỉ ra một lỗ hổng trong phương pháp .Rd hoặc một lỗ hổng trong tài liệu hướng dẫn cho phương pháp .Rd. (Tôi cũng sẽ bắt đầu ghi lại rất nhiều mã và phương trình, vì vậy tôi có một câu hỏi tương tự trong hàng đợi các câu hỏi cần điều tra.) – Iterator