Я работаю над пакетом 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
не использовать это?
Ответ BenBolker является точным. В стороне, я, как правило, частично удовлетворен тем, как форматирование получается как для '\ eqn', так и' \ deqn' –