パッケージビネットはRで利用できません

Question

Rパッケージを構築しています。

vignettes/mydoc.Rmdにrmarkdownファイルがあります。

devtools::build_vignettes()を使用すると、ファイルがinst/docに表示されます。

R CMD build .を使用すると、警告やエラーは表示されません。

しかし、Rの中のvignette()を使用すると、パッケージのビネットは表示されません。

私DESCRIPTIONファイルが含まれています：あなたがステップ間でインストールしている場合はどのように/

Suggests: knitr, 
    rmarkdown, 
VignetteBuilder: knitr 

Answer 1

それは明らかではありません。実行し、あなたの最初のビネットを作成するには

：私はハドレーのRパッケージウェブサイト、ほとんど開発サイクルセクションからビネット章から引用します

devtools::use_vignette("my-vignette") 
This will: 

1. vignettes /ディレクトリを作成します。

2. 説明に必要な依存関係を追加します（つまり、SuggestsフィールドとVignetteBuilderフィールドにknitrを追加します）。

3. ビネット、vignettes/my-vignette.Rmd。

上記手動またはuse_vignette()コマンドを介して行うことができますが、それは実行する必要がありません。

ビネットをオーサリングした後、ビルドする必要があります。

コンソールからすべてのビネットをdevtools::build_vignettes()で構築することはできますが、これはほとんど役に立ちません。代わりにdevtools::build()を使用して、ビネットを含むパッケージバンドルを作成してください。 RStudioの "Build & reload"では、時間を節約するためのビネットは作成されません。同様に、devtools::install_github()（およびお友達）は、時間がかかり、追加のパッケージが必要な場合があるため、デフォルトでビネットを作成しません。 devtools::install_github(build_vignettes = TRUE)で強制的に建物を建てることができます。これにより、すべての推奨パッケージもインストールされます。

私はdevtools::install()には既にビルドされているビネットが含まれていると思われますが、余分な引数はインストール時に再構築する必要がある場合にのみ必要です。

---

R CMD BUILD tarballを作る、それはまたあなたの開発ディレクトリを変更しません、それはあなたの開発ディレクトリを変更しない、とR CMD INSTALLは、ライブラリ内のパッケージをインストールします。

ビネットを再構築してパッケージをインストールする場合は、開発のためにちょうどdevtools::install(..., build_vignettes = T)を使用できます。

CRANにリリースする準備ができたら、本当にパッケージ自体をビルドするだけです（システムに応じてzipまたはtarballを生成する必要があります）。その時点で、R CMD BUILDのラッパーとしてdevtools::build(..., vignettes = T)を使用しますが、それは単なる設定です。