問題タブ [vignette]

コードを実行して、開発中の R パッケージ用のvigentteフォルダーを作成しましたdevtools::use_vignette("my-vignette")。RmarkdownとKnitrパッケージを使用しています。

パッケージをビルドしてリロードすると、パッケージのドキュメント ページに Rmarkdown ファイル (パッケージの長い形式のドキュメントを含む) のタイトルへのハイパーリンクが表示されません。パッケージの DESCRIPTION ファイルへのハイパーリンクと、文書化された関数のヘルプ ページへのハイパーリンクは表示されますが、人々を Rmarkdown ドキュメントに誘導するハイパーリンクは表示されません。パッケージで使用されている機能のヘルプ ページで取得するのと同様の方法で、パッケージの長い形式のドキュメントへのハイパーリンクを取得するには、なぜ、また何をすべきか疑問に思っています。

私は R パッケージを作成しており、ドキュメントのビネットに多くの時間を費やしています。のようなものを追加する必要があるかどうか疑問に思っています

ユーザーが電話をかけるとすぐに表示されます

パッケージのビネットについてユーザーに知らせる最善の方法は何ですか? それとも、明示的な通知なしにユーザーがそれらを探すと想定しているだけですか?

r package調査データで収入の不平等を評価するために構築中ですhttps://github.com/DjalmaPessoa/convey

ここには約 10 個の異なるパブリック マイクロデータ セットがあります - https://github.com/ajdamico/asdfree - データセット固有のビネットで使用例を提供したいと思います。ほとんどの場合、ビネットはまったく同じです。異なる調査で利用できる別のビネットが欲しいだけです。title/vignette名前、調査ロード スクリプト、調査設計オブジェクト名、データセット内の収入変数など、ビネット全体で変化させたいのはほんの一握りです。

私たちが作成しているパッケージには、10 個の異なる公共使用ファイルにわたって (一見ユーザー向けに) データセット固有の方法でデモンストレーションしたい約 12 個の異なる機能がありますが、10 個のほぼ同一のビネットを書きたくありません。

特定のビネットを自動生成する単一のドキュメントを作成する合理的な方法はありますか? Microsoft のメール マージのようなものを考えていますが、これに相当するものは何かわかりません。ありがとう！

2009 年から CRAN にある「sos」パッケージで新たな問題が発生しています。1 つの問題は、「R CMD build sos」が次のように失敗することです。

パッケージは R-Forge で入手できます。ログファイル(build_src) もそこにあります 。これは R-Forge 上の R 3.3.1 からのメッセージです。10.11.5 を実行している Mac OS X で R 3.3.0 から同様の、しかし少し異なるメッセージが表示されます。

このビルド ログは、問題が「sos」ビネットにあることを示唆しています。ただし、ビネットに問題がある場合は、RStudio 0.99.902 で [PDF をコンパイル] をクリックすると表示されるはずです。代わりに、それは「sos.pdf」を生成して完了すると主張しています。(その出力には他の問題がありますが、それは別の投稿の主題です。)

ありがとう、

R3.3.0 を使用した RStudio 0.99.902 の「Compile PDF」は、2009 年以来 CRAN の「sos」パッケージの一部であった「sos」Sweave ビネットに含まれる参照を見つけることができません。「sos.pdf」を生成します。インライン参照が「?」のようなものに置き換えられることを除いて、OKです。

たとえば、「\citet[pp. 以前は「Chambers (2009, pp. 282-283)」に翻訳されていた [{JC09}] が、「?, pp. 282-283」と表示されるようになりました。「\bibitem[Chambers(2009)]{JC09}」エントリはまだファイルの最後にあり、文献目録とともに印刷されますが、RStudio の「Compile PDF」では「\citet[pp. 282-283]{JC09}」。

これを修正する方法について何か提案はありますか?
ありがとう、

私は使用rmarkdownしていますknitr

2 つの質問があります。

rmarkdownQ1:ドキュメントを作成するときに、図のキャプションが表示されない理由がわかりません。

ここに例があります。私はそこに図を取得しますが、図のキャプションはありません!

Q2: RStudio を使用して R パッケージを開発しています。html_vignette以下のコードを使用して作成できます。output: rmarkdown::pdf_vignetteただし、出力を?に変更すると PDF ビネットを作成できない理由がわかりません。後者はエラーを出します：

Error: 'pdf_vignette' is not an exported object from 'namespace:rmarkdown' Execution halted

私はこの分野に不慣れなので、誰かがそれを説明できれば素晴らしいと思います.

パッケージを CRAN に提出していますが、レビュー担当者チームから以下の警告を受けました。

パッケージには VignetteBuilder フィールドがありますが、事前構築済みのビネット インデックスはありません。

実際に走っているときにも見たことがありますdevtools::release()。私は最後のRバージョンを使用しR version 3.3.1ており、次の.Rmdビネットソースがあります:

さらに、デフォルトでファイルに含めknitrました。DESCRIPTION

私は周りを見回しましたが、問題は非常に一般的であるように見えますが、インデックスが構築されない理由 (および強制的に構築する方法) を理解できませんでした。

この質問とその中のリンクは、Googleの上位の結果ですが、問題を解決しません.

R パッケージには、ファイルとして 2 つの従来の Sweave ビネットがあり.Rnwます。パッケージをローカルでチェックすると (R Studio: Build -> Check)、エラーや警告は表示されず、R バージョン 3.3.1 Patched (2016-10 -17 r71531)。

ただし、R devel (unstable) (2016-10-16 r71524)) の下でチェックするために (経由でdevtools::build_win()) Win-builder にパッケージを送信すると、解決できない次の警告が表示されます。

私のパッケージのディレクトリ構造には、次のように in のビネットと inのvignettes/結果が含まれています。devtools::build_vignettes()inst/doc/

.pdf生成されたファイルを に含める理由は、そうしないと、ファイルを で圧縮する必要がinst/doc/あるという警告が表示されるためです。実際にこれを実行できる唯一の方法は、ファイルを Acrobat Pro で開き、圧縮 PDF として再保存することです。 .pdfqpdf

に追加しようとしましinst/docた.Rbuildignoreが、エラーが発生します。私も追加しようとしinst/doc/*.pdfまし.Rbuildignoreたが、それは効果がありません。

警告のため、CRAN に更新を送信できません。の新しいファイルが問題になる理由がわかりませんvignettes/が、どうすれば警告を修正できますか?

パッケージを開発しており、パッケージにビネットを含めることを検討しています。私はパッケージ開発に RStudio を使用し、Hadley Wickam の指示に従ってビネットを使用または作成しました。Rmarkdownknitr

knitRstudio から押すとビネットをコンパイルできますが、コマンドdevtools::check()はエラーを返します。

私は何をすべきか、または変更する必要がありますか? 私はそれが小切手だけであることを知っています。

セッション情報: