パッケージをビルドしてドキュメントを書くための賢明なワークフローを完全には理解していません。
できるだけ多くのプロセス (およびドキュメント) を自動的に生成したいと考えています。
これを行う明白な方法は、 を使用package.skeletonして基本的なパッケージ ファイルを作成し、プログラムでDESCRIPTIONファイルとファイルを上書きすることRdです。これに関する問題は、すべての適切なパラメーターを文書化することを忘れていないことを保証する、自動生成されたフィールドが失われることです。
パッケージの構築とドキュメントの作成について、どのように行っているか知りたいです。プロセスを簡単にするために利用できるツールはありますか? ( roxygenはこの種の目的のために設計されたようです。適切なチュートリアルはありますか? また、代替手段はありますか?)
私はすべてのプロジェクトで roxygen を使用しています。例として、webvisパッケージのソースを参照します。Hadley は、ドキュメンテーションにも roxygen を使用しています (たとえば、彼のlubridate パッケージを参照してください)。
私の知る限りでは、roxygen はビゲットを超えてあまり文書化されていません ( roxygen のホームページを見てください)。
ドキュメントとコードが隣り合わせであるという意味で、読み書きのできるプログラミングにつながるため、Roxygen は優れています。これにより、すべてを一度に処理できるため、ドキュメント プロセスが少し簡単になります。私は間違いなくそれをお勧めします。現時点では、これなしでパッケージを開発することはありません。
とは言っても、一部のドキュメント生成ツール (javadoc など) が行うような意味でドキュメントを自動化するわけではありません。roxygen は適切にフォーマットされた R コメントを解釈しますが、R コードはまったく解釈しません。
一般的なパッケージの作成に関して:package-skeleton初心者に最適です。いくつかのパッケージを作成したら、将来はすべてのディレクトリ、名前空間などを手動で作成する方が簡単であることに気付くかもしれません。特に、デモ ディレクトリを含める、roxygen を使用する、ビネットを作成する、または他の言語のソース コードを含めるなど、他のプラクティスに従う場合はなおさらです。
最後に、Eclipse (StatET) でパッケージを管理します。多くの IDE には、パッケージ構造の管理に役立つ「プロジェクト」ビューがあるため、より高度なエディターを使用することもできます。
roxygen リソースに関しては、私自身のメモを引用するために、さらにいくつかが出現し、さらにいくつかが出現しました。
Roxygen または Roxygen2 をグーグルで検索すると、ドキュメントを見つけるのに苦労することがよくあります。いくつかの重要なリソースをまとめたものを次に示します。
Hadley Wickham が、Roxygen 2 のコア機能を紹介しています。
RStudioにはRoxygenの実行に関する注意事項があります