パッケージドキュメントをどのように書きますか？ [閉まっている

Question

パッケージを構築し、ドキュメントを作成するための賢明なワークフローを理解していません。

できるだけ多くのプロセス（およびドキュメント）を自動的に生成したいと考えています。

これを行う明白な方法は使用することです package.skeleton 基本的なパッケージファイルを作成するには、プログラムで上書きします DESCRIPTION ファイルと Rd ファイル。これに関する問題は、すべての適切なパラメーターを文書化することを覚えていることを保証する自動化されたフィールドを失うことです。

方法を知りたいです 君 パッケージを構築し、文書を作成します。プロセスを簡単にするためのツールはありますか？ （roxygen この種のもののために設計されているように見えます。それに適したチュートリアルはありますか？そして、代替手段はありますか？）

Answer 1

私はすべてのプロジェクトにRoxygenを使用しています。たとえば、ソースを参照してください webvis パッケージ. 。ハドリーはまた、彼のドキュメントにroxygenを使用しています（例：彼の参照 潤滑剤パッケージ).

私の知る限り、Roxygenはヴィベットを超えて文書化されていません（を見てください Roxygenホームページ).

Roxygenは、文書化とコードが並んでいるという意味で、読み書きのできるプログラミングにつながるため、良いです。これにより、すべてを一度に作業しているため、ドキュメントプロセスが少し簡単になります。私は間違いなくそれをお勧めします、そして、この時点でそれなしではパッケージを開発しません。

とはいえ、いくつかのドキュメント世代ツールが行うという意味でドキュメントを自動化するものではありません（例：Javadoc）：Roxygenは適切にフォーマットされているRコメントを解釈しますが、Rコードをいかなる方法でも解釈しません。

一般的にパッケージの作成について： package-skeleton 手始めに最適です。いくつかのパッケージを作成したら、すべてのディレクトリ、ネームスペースなどを手作業で作成するためだけに、将来簡単に見つけることができます。特に、デモディレクトリを含める、roxygenの使用、ビネットの作成、他の言語のソースコードを含めるなど、他のプラクティスのいくつかに従う場合。

最後に、Eclipse（statet）でパッケージを管理します。 IDEの多くには、パッケージ構造の管理に役立つ「プロジェクト」ビューがあるため、より高度なエディターを使用することもできます。

Answer 2

roxygenリソースに関して、さらにいくつかの数が出現し、さらにいくつかが出現しました。 私自身のメモ:

多くの場合、roxygenまたはroxygen2をグーグルで検索すると、ドキュメントを見つけるのに苦労します。これがいくつかの重要なリソースの編集です：

• ハドリー・ウィッカムには素晴らしいです Roxygen 2のコア機能の紹介

• がある roxygen 2のクランサイトにリストされているいくつかのビネット

• Rstudioにはメモがあります roxygenを実行します

• githubのroxygen2パッケージソースコード