Rd文件中的数学符号/上标

Question

我正在为一个函数填写Rd文件。

当我在Details部分使用\eqn{2^{x}}，然后构建和安装包时，没有上标指数。

查看R-exts.pdf，它指向Poisson.Rd作为如何使用\eqn或\deqn的示例。在该文件中的示例中，有一个上标指数。

当我查看Poisson的帮助文件（?Poisson）时，没有上标指数。

这是我的计算机问题还是标准行为？

谢谢！

> sessionInfo()
R version 2.11.1 (2010-05-31) 
i386-apple-darwin9.8.0 

locale:
[1] en_US.UTF-8/en_US.UTF-8/C/C/en_US.UTF-8/en_US.UTF-8

attached base packages:
[1] stats     graphics  grDevices datasets  utils     methods   base     

other attached packages:
[1] cimis_0.1-3    RLastFM_0.1-4  RCurl_1.4-2    bitops_1.0-4.1 XML_3.1-0      lattice_0.18-8

loaded via a namespace (and not attached):
[1] grid_2.11.1  tools_2.11.1

- Greg

Answer 1

现今，人们主要使用HTML帮助文档。

若想在HTML帮助文档和PDF帮助文档中都显示上标，请按照以下步骤进行：

\ifelse{html}{\out{2<sup>x</sup>}}{\eqn{2^x}}

语法如下：

\ifelse{html}{\out{HTML CODE}}{\eqn{LATEX-LIKE CODE}{ASCII}}

支持可选的{ASCII}。

- Stéphane Laurent

---

这个答案对我很有帮助，但我认为第一行缺少一个 {。我认为它应该是 \ifelse{html}{\out{2<sup>x</sup>}}{\eqn{2^x}}，以防对其他人有所帮助。 - teunbrand

Answer 2

您没有说明在哪里查看是否有上标指数。我猜测是文本帮助，而不是手册的PDF版本？

\eqn 宏的语法为 \eqn{latex}{ascii}。其中，{ascii} 部分是可选的，如果省略，则 R 将尽力呈现 LaTeX 版本。按照惯例，ASCII 中的下标应该用 [] 包裹，上标应该用 ^。

因此，我会这样写：

\eqn{2^{x}}{2^x}

但在实际意义上，它们是相同的。问题只是文本帮助无法显示上标，但 PDF 可以。

- Gavin Simpson

---

在 PDF 中看起来很好，我认为它应该在 OS X 的 R.app 帮助查看器中呈现出指数。问题（非问题）已解决。 - Greg

对于基于文本的帮助，请尽可能在\eqn的{ascii}部分中使用 [ ] 和 ^。那是您在该格式中可以实现的最佳效果。 - Gavin Simpson