如何在R帮助文件/ roxygen2中交叉引用方程式
-
28-10-2019 - |
题
我正在记录我正在制作的R包的一些功能。
我正在使用氧气标记,尽管这与我的问题无关。
我已经使用\deqn{...}
将方程式放入我的文档中。我的问题是:
稍后是否可以交叉引用此方程式?
例如,在我的Rd文件中: 通用标签
我以后可以做类似的事情吗?
参考公式\ ref {test},...
我已经尝试过
\eqref{test}
,\ref{test}
(都获得“未知宏”并且不链接),还尝试过\link{test}
(抱怨它找不到功能test
,因为它实际上只是用于链接其他功能)。否则,我担心我可能需要做一些改动,然后在Rd文件的
-- (1)
等中手动添加Refer to equation (1)
和\deqn
等。更新
一般答案似乎是“否”。 (awww ...)
但是,我可以编写一个小插图,并在那里使用“普通”乳胶/包装。无论如何,我只是注意到我花了很长时间才放入我的roxygen / Rd文件中的矩阵方程在帮助的
?myFunction
版本中看起来很糟糕(它们显示为近似字面量的乳胶源)。真可惜,因为它们在帮助的pdf版本中看起来很漂亮。@Iterator指出了条件文本的存在,因此我将在.Rd文件中进行ASCII数学运算,但在pdf手册/渐晕中进行Latex数学运算。
解决方案
为了其他人的利益,我正在将上面的评论整理成答案。
首先,我实际上不知道.Rd是否支持方程式标记。但是,.Rd格式是LaTeX的严格子集,并且会产生非常原始的文本输出,以至于将大量的方程式引入其格式可能是一件痛苦的事,而对用户没有太大好处。
替代方法是使用打包小品,甚至是外部托管的文档(如Hadley Wickham对其某些软件包所做的操作)。这将使您充分使用PDF或其他文档。这样,您可以包括屏幕截图,图表,只有您拥有的所有最时髦的LaTeX扩展,最重要的是,我们都知道和喜欢的AMS扩展。
不过,您可以根据界面指定给定文档部分(以.Rd格式)的不同呈现方式,例如控制台的文本,HTML的漂亮字符等,以及条件文本支持这种格式变化。
这是一个好问题。我不知道关于可行性的答案,但是对于将函数和方程式一起记录也有类似的问题,对.Rd文件可行的研究使我确信我使用PDF渐晕而不是.Rd文件。