Rd文件中的数学概念/上标

时间:2010-09-23 20:33:05

标签: r documentation

我正在为一个函数填写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

2 个答案:

答案 0 :(得分:5)

你没有说你在哪里看是否有上标指数。我认为基于文本的帮助,而不是手册的PDF版本?

\eqn宏的语法是\eqn{latex}{ascii}{ascii}位是可选的,在这种情况下,R将最好呈现LaTeX版本。按照惯例,ASCII中的下标将包含在[]中,而下标则包含在^。

所以我会写:

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

但从实际意义上讲,这些都是一样的。问题只是文本帮助无法显示超级标记,但PDF可以。

答案 1 :(得分:3)

如今,人们主要使用HTML帮助。

要获取HTML帮助以及PDF帮助中的上标,请执行以下操作:

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

语法为:

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

{ASCII}可选。