2017-01-30 16 views
0

私はRStudioで最初のパッケージを作成しようとしています。Rプログラムを再帰的に文書化します

私はすでにRファイルでプロジェクトを持っていたと私はちょうどこのようなプロジェクトのレイアウトを変更:

Package: my-package 
Title: Package title 
Version: 0.0.0.9000 
[email protected]: person("Ben", 
    "Me", 
    email = "[email protected]", 
    role = c("aut", "cre")) 
Description: blabla 
Depends: 
    R (>= 3.3.2) 
License: file LICENSE 
Encoding: UTF-8 
LazyData: true 
VignetteBuilder: knitr 
Suggests: 
    knitr, 
    rmarkdown 
RoxygenNote: 5.0.1 

私のすべての機能がroxygenコメントを含める:

. 
|-R 
|---File 
|---Physics 
|---Plot 
|---Utils 
|-man 
|-vignettes 
|-DESCRIPTION 
|-NAMESPACE 

私の説明ファイルには、次のテキストが含まれています。私はRStudioでビルド/ドキュメントの機能を使用する場合、それは言う:

==> devtools::document(roclets=c('rd', 'collate', 'namespace', 'vignette')) 

Updating my-package documentation 
Loading my-package 
Writing NAMESPACE 
Updating vignettes 
Documentation completed 

しかし、manページや名前空間ファイルは空のまま。

私がビルドする場合&プロジェクトをリロードすると、No man pages found in packageというメッセージが表示されます。

ドキュメントコマンドが正しく適用されなかったと思います。コメント付きのRスクリプトをRフォルダのルートに直接置くと、それが見つけられます。 RStudioがすべてのコードフォルダを再帰的に探索できるようにする方法はありますか?Rフォルダのルートにすべてのファイルを置くだけですか(Javaの世界から来る人にとっては面倒です...)?

+0

まず、正しいフォルダ構造を試してください。また、これはRstudioの問題ではありません。 –

+0

正しいフォルダ構造はフラットな構造ですか? – Ben

答えて

1

R documentationのみ、以下のフォルダが許可されている状態(と自分自身の機能を持っている):

男サブディレクトリがマクロという名前のサブディレクトリが含まれていてもよいです。これには、ユーザー定義のRdマクロのソースが含まれます。 (ユーザー定義のマクロを参照してください。)これらはRd形式を使用しますが、マクロ定義、コメント、および空白以外のものは含まれません。

Rと男のサブディレクトリがUNIXまたはという名前のOS固有のサブディレクトリが含まれていてもよいです。

+0

それは奇妙に感じる。大きなパッケージには1つのフォルダにたくさんのファイルがあることを意味します。 IMHOを維持することは容易ではありません。 – Ben

+0

@Benこれらのファイルには、わかりやすい命名規則を自由に使用することができます。例えば、ggplot2のような大きなパッケージがどうしているのかを調べてみましょう:https://github.com/tidyverse/ggplot2/tree/master/R – Roland

+0

@Benはfile_、physics_、plot _...のようにファイルを追加します。 –

関連する問題