我正在为我正在制作的 R 包记录我的一些功能。
我正在使用 roxygen 标记，尽管这与我的问题基本无关。
我已使用 \deqn{...} 将方程式放入我的文档中.我的问题是:
以后有没有办法交叉引用这个等式？
例如，在我的 Rd 文件中:
\deqn{\label{test}
y = mx + b
}
Referring to equation \ref{test}, ...
我试过
\eqref{test} , \ref{test} (它们都得到“未知宏”并且没有得到链接)，还有 \link{test} (它提示它找不到函数 test 因为它实际上只是用于链接到其他函数)。否则我担心我可能不得不做一些hacky并添加
-- (1)和 Refer to equation (1)在 \deqn 内手动Rd文件中的等...更新
一般的答案似乎是“不”。 (呜呜……)
但是，我可以写一个小插图并在那里使用“普通” latex /包。无论如何，我刚刚注意到我花了很长时间放入我的 roxygen/Rd 文件中的矩阵方程在
?myFunction 中看起来很糟糕。帮助的版本(它们显示为几乎文字 latex 源)。这是一种耻辱，因为它们在帮助的 pdf 版本中看起来很漂亮。@Iterator 已经指出 conditional text 的存在，所以我会在 .Rd 文件中做 ASCII 数学，但在 pdf 手册/小插图中做 latex 数学。
最佳答案
为了他人的利益，我正在将我上面的评论汇编成一个答案。
首先，我实际上不知道 .Rd 是否支持方程标记。然而，.Rd 格式是 LaTeX 的一个严格子集，产生非常原始的文本输出，将大量方程硬塞进它的格式可能是一项痛苦的工作，对用户没有太大好处。
替代方法是使用 package vignettes ，甚至外部托管的文档(如 Hadley Wickham 所做的，对于他的一些软件包)。这将允许您随心所欲地使用 PDF 或其他文档。通过这种方式，您可以包含屏幕截图、绘图、所有只有您拥有的最时髦的 LaTeX 扩展，以及最重要的是我们都知道和喜爱的 AMS 扩展。
尽管如此，可以根据界面指定文档的给定部分(在 .Rd 中)的不同呈现，例如控制台的文本、HTML 的漂亮字符等，以及 conditional text支持那种格式变化。
这是个好问题。我不知道关于可行性的答案，但我有关于将函数和方程一起记录的类似问题，并且对 .Rd 文件的可行性的调查使我说服我使用 PDF 小插图而不是 .Rd 文件。
关于r - 如何交叉引用 R 帮助文件/roxygen2 中的方程，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/9373253/