2016-05-23 4 views
3

Я работаю над пакетом R, и я использую пакет Roxygen2, чтобы написать справочные руководства по моим R функциям. Я хотел бы знать, можно ли использовать латекс для математических уравнений на страницах руководства?В пособии для справки R можно найти латексную математику?

Например, если у меня была функция называется add2, который сделал следующее:

add2 = function(x,y){ 
     z = x+y 
     return(z) 
} 

И используя Roxygen2 документацию у меня было следующее:

##' @include add2.R 
{} 

##' Compute the sum of x_1 and x_2 
##' 
##' Computes the sum of x_1 and x_2 
##' 
##' @param x_1 number of guys 
##' @param x_2 number of girls 
##' @return The sum of the two values x_1 and x_2 
##' 
##' @example examples/adding.R 
##' @export 
##' @author Name 

И это работает для меня, но это отображает x1 и x2 как x_1 и x_2 в справочном руководстве, тогда как я хотел бы, чтобы он выглядел как латексная математика и фактически имел индексы на x, то есть $ x_1 $ и $ x_2 $ в латексе.

Есть ли способ для этого или нет R не использовать это?

+1

Ответ BenBolker является точным. В стороне, я, как правило, частично удовлетворен тем, как форматирование получается как для '\ eqn', так и' \ deqn' –

ответ

7

Вид. Используйте что-то вроде \eqn{x_1}, если вы хотите использовать (необработанную) версию разметки LaTeX в текстовом виде (попеременно можно сказать что-то вроде \eqn{x_1}{x1}). Часть «своего рода» заключается в том, что я не уверен, для каких конкретных форматов вывода обработка LaTeX будет выполнена - например, я предполагаю, что версия вывода в формате HTML, которую вы увидите в (например) Панель документации RStudio будет не уважать эту разметку. (Латекс разметка определенно будет использоваться в PDF-версии руководства, которые я почти никогда не смотрю на ...)

Я собираюсь идти вперед и цитату из Mathematics section of Writing R Extensions ...

Математические формулы должны быть прекрасно подобраны для печатной документации, но мы все же хотим что-то полезное для текстовой и HTML-справки в Интернете. Для этого используются две команды: \ eqn {latex} {ascii} и \ deqn {latex} {ascii}. В то время как \ eqn используется для «встроенных» формул (соответствующих TeX $ ... $), \ deqn дает «отображаемые уравнения» (как в среде отображения LaTeX, или в TeX $$ ... $$). Оба аргумента рассматриваются как «дословный» текст.

Обе команды также могут использоваться как \ eqn {latexascii} (только один аргумент), который затем используется как для латекса, так и для ascii. Между командами и первым аргументом не допускается пробел, а также между первым и вторым аргументами.

Следующий пример из Poisson.Rd:

\ deqn {! Р (х) = \ гидроразрыва {\ Lambda^х^{- \ Lambda}} {х}} {%

p (x) = \ lambda^x exp (- \ lambda)/x!} для \ eqn {x = 0, 1, 2, \ ldots}.