web-dev-qa-db-ja.com

R R CMDチェック付きのリファレンスマニュアルを作成する

私はRパッケージを書いており、パッケージ内のすべての関数のPDFリファレンスマニュアルを作成したいと考えています。 こちら から、R CMD checkが自動的にリファレンスマニュアルを作成することがわかりました。

ここ 「NAMESPACEのエクスポートセクションにリストした関数の」手動エントリが作成されると読みました。

私のNAMESPACEファイルは次のようになります。

# Export all names
exportPattern(".")

# Import all packages listed as Imports or Depends
import(
  LIM
)

だから、すべてが輸出されると思った。パッケージディレクトリのR CMD checkの間、最後に次のように表示されます。

 * checking PDF version of manual ... OK

ただし、パッケージディレクトリにリファレンスマニュアルがありません（inst/docにあると思います）。ここで何が欠けていますか？

rpackagereference-manual
38
user1981275

R CMD checkは、ディレクトリPACKAGE.RCheckを作成します。このディレクトリには、ファイルPACKAGE-manual.pdfがあります。

23
sgibb

もう1つの方法は、次を使用してリファレンスマニュアルを直接作成することです。

R CMD Rd2pdf mypackage

ここで、mypackageは、.Rdファイルを含むmanフォルダーを含む、Rパッケージコードフォルダー構造を含むフォルダーです。

何らかの理由で、RStudioのビルドまたはチェック中にリファレンスマニュアルを取得できませんでした。おそらくどこかで設定を見逃している可能性があります。ただし、このようなコマンドを実行しても問題はありません。

80
FvD

同じ問題がありました。 Rstudioで[ビルド]または[チェック]（devtoolsを使用している場合）をクリックすると、デフォルトで「--no-manual」の引数がR CMDオプションに追加されるようです。

Rコマンドプロンプトで手動で引数を指定することでこれを解決しました。

library(devtools)

check(cleanup = FALSE,manual = TRUE,path = getwd())

# without running the examples
check(cleanup = FALSE,args = c('--no-examples'),manual = TRUE,path = getwd())

この場合、package.Rcheckと呼ばれるフォルダーには、package-manual.pdfとしてマニュアルが含まれます。

また、チェック中に出力にエラーがないか確認してください。ドキュメントをクラッシュさせる可能性のある文字があるかもしれません。

3
Atesh

もう1つの回避策は、次の方法で作成することです。

build_manual(path=getwd())
#or
check(manual = TRUE, args="--output=~/folder/subfolder")
1
Ferroao