2016-02-27 2 views
5

一部Rパッケージ(例えば、ggplot2dplyrdevtoolsなど)Rパッケージのヘルプ/ドキュメントにセクションを追加します。 )。他のパッケージ(たとえば、RcmdrMisc)には含まれていません。はアルファベット順に下の写真の赤い矢印で示されている(彼らの助け/ドキュメントおよびそれらのセクションへのリンクバーにセクションを題してき

Rパッケージのヘルプにこれらの要素を追加するにはどうすればよいですか?私はドキュメンテーションのためroxygen2を使用

ggplot2 help

。ライティングR Extensionsで

+0

良い質問!私は、パッケージのソースコードが答えを与えることができると思います(もし誰もがそれを知っていなければ)。 –

+0

私が知る限り、これらのインデックスファイルは自動生成されます。少なくとも、私のパッケージには常にそれらがありますが、私はそれらを書きません。私はいつもこれらの文字が自動的に追加されると思っていました。しかし、私は間違っているかもしれません。 – Stibu

+0

私はGitHubでいくつかのパッケージの構造を研究しましたが、そのアルファベット順のインデックスを作る方法はまだ分かりませんでした。 – Vilmantas

答えて

1

(CRANからRのすべてのコピーに含まれる)のファイルは、INDEXファイルに関する小さなセクションです:

1.1.4 INDEXファイル

オプションのファイルINDEXが含まれていますパッケージ内のそれぞれの興味深いオブジェクトの名前と説明(通常は明示的に呼び出されないprintメソッドなどの関数は含まれていないかもしれません)を与える行です。通常、このファイルは存在しません。対応する情報は、ソースからインストールする際にドキュメントソース(tools::Rdindex()を使用)から自動的に生成されます。

パッケージにインデックスファイルがある場合、HTMLコードはhtmlフォルダにあります。

+0

私のパッケージのインストールされたバージョンの 'html'フォルダが見つかりましたが、私はまだセクションを作る方法を理解していません。パッケージのインストール時に 'tools :: Rdindex()'関数がインデックスを持つHTMLファイルを作成するのはどうでしょうか? – Vilmantas

+0

それは普通のプロセスの私の理解です。自動化。 –

関連する問題