Skip to content

Dokumentation von Gleichungen mit deqn und roxygen

Lösung:

Laut Hadley Wickham wird der Zeilenumbruch in zukünftigen Versionen von roxygen entfernt. Die Lösung für roxygen2 besteht also darin, die Datei (oder das Paket) zu roxygenisieren und dann die Textgleichung im betroffenen Bereich manuell zu aktualisieren .Rd Datei(en).

Diese Antwort befasst sich nicht mit Ihrem ASCII-Problem, ist jedoch derzeit meine erste Wahl beim Rendern von Latexgleichungen in HTML. Ich hoffe, dies hilft Ihnen.

Schauen Sie sich das mathjaxr-Paket (CRAN, GitHub) an. Sie können es entweder mit installieren install.packages("mathjaxr") oder remotes::install_github("wviechtb/mathjaxr").

Es führt ein Makro ein loadmathjax das das erforderliche JavaScript von MathJax lädt, um Latexgleichungen zu rendern. Dann benutze das Makro mjeqn{latex}{ascii} oder mjdeqn{latex}{ascii} Anstatt von eqn oder deqn und schon kann es losgehen.

In Ihrem spezifischen Beispiel hätten wir Folgendes:

#' Example
#'
#' Example mathjax function
#'
#' loadmathjax
#' mjdeqn{ sigma = sqrt{ frac{Z}{n} sum
#'   textstylefrac{1}{2}displaystyle
#'     left[ left( log frac{H_i}{L_i} right)^2  - (2log 2-1) left( log frac{C_i}{O_i} right)^2 right] }
#' }{ASCII representation}
example <- function(a, b, c) {}

(beachten Sie, dass die offene eckige Klammer mit Escapezeichen versehen ist)

Wenn Sie RStudio verwenden, können Probleme mit dem loadmathjax Makro. Um den Inhalt schnell in der Vorschau anzuzeigen, gehen Sie wie folgt vor:

  1. Dokumentation erstellen (Strg + Umschalt + D oder devtools::document(roclets = c('rd', 'collate', 'namespace')))
  2. Anruf preview_rd("example.Rd") um eine Vorschau der Dokumentation anzuzeigen

Wenn Sie fertig sind, können Sie das Endergebnis mit diesen Schritten überprüfen:

  1. Dokumentation erstellen (Strg + Umschalt + D oder devtools::document(roclets = c('rd', 'collate', 'namespace'))
  2. Installieren Sie das Paket (Strg + Umschalt + L oder devtools::install())
  3. Starten Sie die R-Sitzung neu mit .rs.restartR()
  4. Vorschau der Dokumentation mit ?example

Beides sollte das folgende Ergebnis liefern:

gerenderte Mathjax-Gleichung

Click to rate this post!
[Total: 0 Average: 0]



Anderer Beitrag

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.