3

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

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

4

1 に答える 1

1

ダラー、

表示されているエラーの詳細を教えていただけますか? コードが github に投稿されている場合、または特定のエラーがある場合は、さらに支援できる可能性があります。そうでない場合は、Hadley Wickam の「R Packages」本をオンラインでチェックすることをお勧めします。これは非常に参考になります。

http://r-pkgs.had.co.nz/

これにより、少なくともビネットの作成方法がよくわかります。

http://r-pkgs.had.co.nz/vignettes.html

上記で参照した Hadley Wickham のオンライン ブックから...

クランノート

ビネットをローカルで作成するため、CRAN は html/pdf とソース コードのみを受け取ることに注意してください。ただし、CRAN はビネットを再構築しません。コードが実行可能であることのみを確認します (実行することによって)。これは、ビネットで使用されるすべてのパッケージを記述で宣言する必要があることを意味します。ただし、これは、CRAN に pandoc がインストールされていなくても、(pandoc を使用する) Rmarkdown を使用できることも意味します。

一般的な問題:

ビネットはインタラクティブにビルドされますが、チェックすると、インストールされていることがわかっているパッケージが見つからないというエラーで失敗します。これは、DESCRIPTION でその依存関係を宣言するのを忘れたことを意味します (通常は Suggests に入れる必要があります)。

すべてがインタラクティブに機能しますが、パッケージをインストールした後、ビネットは表示されません。以下のいずれかが発生した可能性があります。まず、RStudio の「ビルドとリロード」ではビネットがビルドされないため、代わりに devtools::install() を実行する必要がある場合があります。次のチェック:

  • ディレクトリは vignettes/ と呼ばれ、vignette/ ではありません。
  • .Rbuildignore でビネットを誤って除外していないことを確認してください
  • 必要なビネット メタデータがあることを確認します。
  • error = TRUE を使用する場合は、purl = FALSE を使用する必要があります。

ファイルサイズに注意する必要があります。多くのグラフィックを含めると、非常に大きなファイルが簡単に作成されます。厳格な規則はありませんが、非常に大きなビネットがある場合は、ファイル サイズを正当化するか、小さくする準備をしてください。

于 2016-05-01T05:03:51.000 に答える