Ns

deqnとroxygenを使用した方程式の文書化



Documenting Equations With Deqn



解決：

Hadley Wickhamによると、将来のバージョンのroxygenでは行の折り返しが削除される予定です。したがって、roxygen2の解決策は、ファイル（またはパッケージ）をroxygenizeしてから、影響を受けるテキスト方程式を手動で更新することです。.Rdファイル。


この回答はASCIIの問題に対処していませんが、現在HTMLでラテックス方程式をレンダリングする際の私の頼りになる方法なので、これがお役に立てば幸いです。



mathjaxrパッケージ（CRAN、GitHub）を見てください。どちらでもインストールできますinstall.packages（ 'mathjaxr'）またはremotes :: install_github（ 'wviechtb / mathjaxr'）。

マクロを紹介しますラテックス方程式をレンダリングするためにMathJaxから必要なJavaScriptをロードする loadmathjax。次に、マクロを使用します mjeqn {latex} {ascii}または mjdeqn {latex} {ascii}の代わりに eqnまたは deqnそしてあなたは行ってもいいです。



特定の例では、次のようになります。

＃ '例＃'＃ 'mathjax関数の例＃'＃ ' loadmathjax＃'  mjdeqn { sigma =  sqrt { frac {Z} {n}  sum＃ ' textstyle  frac {1} {2}  displaystyle＃ ' left  [ left（ log  frac {H_i} {L_i}  right）^ 2-（2  log 2-1） left（ log  frac {C_i} {O_i}  right） ^ 2  right]}＃ '} {ASCII表現}の例<- function(a, b, c) {}  
（開いた角括弧がエスケープされていることに注意してください）
 
RStudioを使用している場合、問題が発生する可能性があります。 loadmathjaxマクロ。コンテンツをすばやくプレビューするには、次の手順を実行します。
 
 
 
     
  1. ドキュメントを生成します（Ctrl + Shift + Dまたはdevtools :: document（roclets = c（ 'rd'、 'collat​​e'、 'namespace'）））
    2.  
  2. 電話ドキュメントをプレビューするにはpreview_rd（ 'example.Rd'）
    3.  
 
完了したら、次の手順で最終結果を確認できます。
 
     
  1. ドキュメントを生成します（Ctrl + Shift + Dまたはdevtools :: document（roclets = c（ 'rd'、 'collat​​e'、 'namespace'））
    2.  
  2. パッケージをインストールします（Ctrl + Shift + Lまたはdevtools :: install（））
    3.  
  3.   Rセッションを再開します と.rs.restartR（）
    4.  
  4. ドキュメントのプレビュー？例
    5.  
 
どちらの方法でも、次の結果が得られます。
 
 レンダリングされたmathjax方程式