13

私は、作成中の R パッケージの関数の一部を文書化しているところです。

私は roxygen マークアップを使用していますが、それは私の質問とはほとんど関係ありません。

を使用してドキュメントに方程式を入れました\deqn{...}。私の質問は 、この方程式を後で相互参照する方法はありますか?

たとえば、私の Rd ファイルでは次のようになります。

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

後で次のようなことができますか:

方程式 \ref{test} を参照すると、...

\eqref{test}、\ref{test}（「不明なマクロ」を取得し、リンクされていない）、および（実際には他の関数にリンクするためだけに\link{test}機能が見つからないことを訴える）も試しました。test

そうしないと、何かハックなことをして、Rd ファイルの etc 内に-- (1)手動Refer to equation (1) で追加する必要があるのではないかと心配しています...\deqn

アップデート

一般的な答えは「いいえ」のようです。(あぁ…)

ただし、ビネットを作成して、そこで「通常の」ラテックス/パッケージを使用することはできます。いずれにせよ、roxygen/Rd ファイルに何年もかけて入力した行列方程式?myFunctionが、ヘルプのバージョンでは見栄えが悪いことに気付きました (ほぼ文字通りのラテックス ソースとして表示されます)。PDF版のヘルプでは美しく見えるので、これは残念です。

@Iterator はconditional textの存在を指摘したので、.Rd ファイルでは ASCII 演算を行いますが、PDF マニュアル/ビネットでは Latex 演算を行います。

4

1 に答える 1

5

他の人の利益のために、上記のコメントを回答にまとめています。

まず、.Rd が方程式のタグ付けをサポートしているかどうかは実際にはわかりません。ただし、.Rd 形式は LaTeX の厳密なサブセットであり、非常に原始的なテキスト出力を生成するため、その形式に大量の方程式を押し込むことは、ユーザーにとって大きなメリットがなく、骨の折れる作業になる可能性があります。

別の方法は、パッケージ ビネット、または外部でホストされているドキュメントを使用することです (Hadley Wickham が一部のパッケージで行っているように)。これにより、PDF やその他のドキュメントを心ゆくまで使用できるようになります。このようにして、スクリーンショット、プロット、あなただけが持っている最もファンキーな LaTeX 拡張機能のすべて、そして最も重要なのは、私たち全員が知っていて愛している AMS 拡張機能を含めることができます.

それにもかかわらず、コンソールのテキスト、HTML の素敵な文字など、インターフェイスに基づいてドキュメントの特定のセクション (.Rd 内) の異なるレンダリングを指定でき、条件付きテキストはその種の形式のバリエーションをサポートします。

いい質問です。実現可能性に関する答えはわかりませんが、関数と方程式を一緒に文書化することについて同様の質問がありました。.Rd ファイルで何が実現可能かを調査した結果、.Rd ファイルではなく PDF ビネットを使用することにしました。

于 2012-02-22T00:25:26.770 に答える