13

我正在为我正在制作的 R 包记录我的一些功能。

我正在使用 roxygen 标记,尽管这在很大程度上与我的问题无关。

我已经将方程式放入我的文档中,使用\deqn{...}. 我的问题是: 以后有没有办法交叉引用这个等式?

例如,在我的 Rd 文件中:

\deqn{\label{test}
 y = mx + b
}

我以后可以做类似的事情吗:

参考方程 \ref{test}, ...

我试过了\eqref{test}\ref{test}(它们都得到“未知宏”并且没有得到链接),而且\link{test}(它抱怨它找不到函数test,因为它实际上只是为了链接到其他函数)。

否则我担心我可能不得不做一些hacky并在Rd文件的etc中手动-- (1)添加和...Refer to equation (1) \deqn

更新

一般的答案似乎是“不”。(哇……)

但是,我可以写一个小插图并在那里使用“普通”乳胶/包。无论如何,我刚刚注意到我花了很长时间放入我的 roxygen/Rd 文件的矩阵方程?myFunction在帮助版本中看起来很糟糕(它们显示为几乎字面的乳胶源)。真可惜,因为它们在 pdf 版本的帮助中看起来很漂亮。

@Iterator 指出了条件文本的存在,所以我将在 .Rd 文件中进行 ASCII 数学运算,但在 pdf 手册/插图中进行乳胶数学运算。

4

1 回答 1

5

为了他人的利益,我将上面的评论编译成答案。

首先,我实际上不知道 .Rd 是否支持方程标记。然而,.Rd 格式是 LaTeX 的一个非常严格的子集,并且会产生非常原始的文本输出,因此将大量方程式硬塞进它的格式可能是一项痛苦的工作,对用户没有太大的好处。

另一种方法是使用包 vignettes,甚至是外部托管的文档(就像 Hadley Wickham 对他的一些包所做的那样)。这将允许您随心所欲地使用 PDF 或其他文档。通过这种方式,您可以包含屏幕截图、绘图、只有您拥有的所有最有趣的 LaTeX 扩展,以及最重要的是,我们都知道和喜爱的 AMS 扩展。

尽管如此,可以根据界面指定文档给定部分(在 .Rd 中)的不同呈现方式,例如控制台的文本、HTML 的漂亮字符等,并且条件文本支持这种格式变化。

这是个好问题。我不知道关于可行性的答案,但我对一起记录函数和方程有类似的问题,并且对 .Rd 文件的可行性的调查使我确信使用 PDF 插图而不是 .Rd 文件。

于 2012-02-22T00:25:26.770 回答