Rヘルプファイル/ roxygen2で方程式を相互参照する方法
-
28-10-2019 - |
質問
作成中のRパッケージの関数の一部を文書化する過程にあります。
私はroxygenマークアップを使用していますが、それは私の質問とはほとんど関係ありません。
\deqn{...}
を使用してドキュメントに方程式を入れました。私の質問は:
後でこの方程式を相互参照する方法はありますか?
たとえば、私のRdファイル: ジェネラコディセタグプレ
後で次のようなことができますか:
方程式\ ref {test}を参照すると、...
\eqref{test}
、\ref{test}
(どちらも「不明なマクロ」を取得し、リンクされません)、および\link{test}
(関数test
が他の関数にリンクするためだけのものであるため、関数が見つからないと文句を言います)を試しました。そうしないと、何かハッキーなことをして、ジェネラコディセタグコードとジェネラコディセタグコードをRdファイルのジェネラコディセタグコードなどに手動で追加しなければならないのではないかと心配しています...
更新
一般的な答えは「いいえ」のようです。 (awww ...)
ただし、ビネットを作成して、そこで「通常の」ラテックス/パッケージを使用することはできます。いずれにせよ、私が何年もかけてroxygen / Rdファイルに入れていた行列方程式が、
-- (1)
バージョンのヘルプではひどいように見えることに気づきました(文字通りのラテックスソースとして表示されます)。ヘルプのPDFバージョンでは美しく見えるので、これは残念です。@Iteratorは、
条件付きテキストの存在を指摘していますなので、.RdファイルではASCII計算を行いますが、PDFマニュアル/ビネットではラテックス計算を行います。
解決
他の人の利益のために、上記のコメントを回答にまとめています。
まず、.Rdが方程式のタグ付けをサポートしているかどうかは実際にはわかりません。ただし、.Rd形式はLaTeXの非常に厳密なサブセットであり、非常に原始的なテキスト出力を生成するため、広範な方程式をその形式に組み込むことは、ユーザーにとって大きなメリットがなく、骨の折れる作業になる可能性があります。
別の方法は、
それでも、コンソールのテキスト、HTMLの素敵な文字など、インターフェイスに基づいて、ドキュメントの特定のセクション(.Rd内)のさまざまなレンダリングを指定できます。条件付きテキストはそのようなフォーマットのバリエーションをサポートしています。
いい質問ですね。実現可能性に関する答えはわかりませんが、関数と方程式を一緒に文書化することについて同様の質問がありました。.Rdファイルで何が実現可能かを調査した結果、.RdファイルではなくPDFビネットを使用するようになりました。