Können R-Handbücher Latex Mathe in ihnen haben?

Question

Ich arbeite an einem R Paket und ich benutze das Paket Roxygen2 um die Handbücher für meine R Funktionen zu schreiben. Was ich gerne wissen würde, ist, wenn es möglich ist, Latex für mathematische Gleichungen in den Manpages zu verwenden?

Zum Beispiel, wenn ich eine Funktion hatte genannt add2, die Folgendes hat:

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

Und mit Roxygen2 Dokumentation hatte ich folgendes:

##' @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 

Und das funktioniert für mich, aber diese zeigt x1 und x2 als x_1 und x_2 in der Hilfe an, während ich möchte, dass es wie Latex-Mathe aussieht und tatsächlich die Indizes auf x hat, dh $ x_1 $ und $ x_2 $ in Latex.

Gibt es eine Möglichkeit, dies zu tun, oder wird R dies nicht akzeptieren?

Answer 1

Sortieren von. Verwenden Sie etwas wie \eqn{x_1}, wenn Sie die (unverarbeitete) Version des LaTeX-Markups in Klartextausgabe verwenden möchten (alternativ könnten Sie etwas wie \eqn{x_1}{x1} sagen). Der "Sort" -Teil ist, dass ich nicht sicher bin, für welche speziellen Ausgabeformate die LaTeX-Verarbeitung durchgeführt wird - zum Beispiel nehme ich an, dass die HTML-formatierte Version der Ausgabe, in der Sie sehen würden (z. B.) Das RStudio-Dokumentationsfenster würde nicht respektieren dieses Markup. (Der LaTeX-Markup definitiv wird in den PDF-Versionen des Handbuchs verwendet werden, die ich so gut wie nie sehen ...)

Ich werde von der Mathematics section of Writing R Extensions voraus und Zitat gehen ...

Mathematische Formeln sollten schön für gedruckte Dokumentation eingestellt werden, aber wir wollen immer noch etwas Nützliches für Text und HTML-Online-Hilfe. Zu diesem Zweck werden die beiden Befehle \ eqn {latex} {ascii} und \ deqn {latex} {ascii} verwendet. Während \ eqn für "Inline" -Formeln verwendet wird (entsprechend TeX $ ... $), gibt \ deqn "angezeigte Gleichungen" (wie in LaTeX's Displaymath-Umgebung oder TeX's $$ ... $$). Beide Argumente werden als "wörtlich" Text behandelt.

Beide Befehle können auch als \ eqn {latexascii} (nur ein Argument) verwendet werden, das dann sowohl für Latex als auch für ASCII verwendet wird. Zwischen dem Befehl und dem ersten Argument sowie zwischen dem ersten und dem zweiten Argument ist kein Leerzeichen zulässig.

Das folgende Beispiel ist aus Poisson.Rd:

\ deqn {! P (x) = \ frac {\ lambda^^ {xe - \ lambda}} {x}} {%

p (x) = \ lambda^x exp (- \ lambda)/x!} für \ eqn {x = 0, 1, 2, \ ldots}.