So verweisen Sie auf eine Gleichung in einer R-Hilfedatei / roxygen2

Question

Ich bin gerade dabei, einige meiner Funktionen für ein von mir erstelltes R-Paket zu dokumentieren.

Ich verwende Sauerstoff-Markup, obwohl dies für meine Frage weitgehend irrelevant ist.

Ich habe Gleichungen mit \deqn{...} in meine Dokumentation aufgenommen. Meine Frage ist: Gibt es eine Möglichkeit, diese Gleichung später zu verweisen?

Zum Beispiel in meiner Rd-Datei:

\deqn{\label{test}
 y = mx + b
}

Kann ich später etwas tun wie:

Unter Bezugnahme auf Gleichung \ ref {test}, ...

Ich habe versucht, \eqref{test}, \ref{test} (die beide "unbekanntes Makro" erhalten und nicht verknüpft werden), und auch \link{test} (der sich beschwert, dass die Funktion test nicht gefunden werden kann, weil sie wirklich nur zum Verknüpfen mit anderen Funktionen dient).

Andernfalls befürchte ich, dass ich etwas Hackiges tun und den -- (1) und den Refer to equation (1) manuell im \deqn usw. in der Rd-Datei hinzufügen muss ...

Update

Die allgemeine Antwort scheint "Nein" zu sein. (awww ...)

Ich kann jedoch eine Vignette schreiben und dort "normales" Latex / Pakete verwenden. Auf jeden Fall ist mir gerade aufgefallen, dass die Matrixgleichungen, die ich ewig in meine roxygen / Rd-Datei geschrieben habe, in der ?myFunction-Version der Hilfe schrecklich aussehen (sie werden als nahezu wörtliche Latexquelle angezeigt). Was schade ist, denn sie sehen in der PDF-Version der Hilfe wunderschön aus.

@Iterator hat auf das Vorhandensein von bedingtem Text hingewiesen , also mache ich ASCII-Mathematik in den .Rd-Dateien, aber Latex-Mathematik im PDF-Handbuch / in der Vignette.

Answer 1

Ich fasse meine obigen Kommentare zu einer Antwort zusammen, zum Nutzen anderer.

Erstens weiß ich nicht, ob .Rd das Markieren von Gleichungen unterstützt oder nicht. Das .Rd-Format ist jedoch eine so strenge Teilmenge von LaTeX und erzeugt eine sehr primitive Textausgabe, dass es ein schmerzhaftes Unterfangen sein kann, umfangreiche Gleichungen in sein Format zu integrieren, ohne dass dies für den Benutzer von großem Nutzen ist.

Die Alternative besteht darin, Paketvignetten oder sogar extern gehostete Dokumentation (wie von Hadley Wickham für einige seiner Pakete). Auf diese Weise können Sie PDFs oder andere Dokumentationen nach Herzenslust verwenden. Auf diese Weise können Sie Screenshots, Diagramme, alle funkigsten LaTeX-Erweiterungen, die nur Sie haben, und vor allem die AMS-Erweiterungen einschließen, die wir alle kennen und lieben.

Trotzdem kann man basierend auf der Benutzeroberfläche ein anderes Rendering eines bestimmten Dokumentationsabschnitts (in .Rd) angeben, z. B. Text für die Konsole, nette Zeichen für HTML usw. und bedingter Text unterstützt diese Art von Formatvariation.

Das ist eine gute Frage. Ich kenne die Antwort bezüglich der Machbarkeit nicht, aber ich hatte ähnliche Fragen zur gemeinsamen Dokumentation von Funktionen und Gleichungen, und diese Untersuchung, was mit .Rd-Dateien machbar ist, hat mich überzeugt, PDF-Vignetten anstelle von .Rd-Dateien zu verwenden.