2016-06-20 9 views
4

devtoolsを使用してRパッケージを構築しています。すべてのドキュメントはroxygen2を使用して構築されています。関数の場合、これはうまくいきますが、パッケージ全体のヘルプページをどのように提供すればよいのでしょうか?私が構築されたことができます/デベロッパーツールで、このインデックスページをリンクする方法devtoolsを使用してRパッケージのメインヘルプページ(インデックス)を作成します。

Screenshot from dplyr package (exemplary index link)

他のパッケージでは、リンクはインデックスページにつながる各ヘルプページの一番下に常にありますか?

EDIT: "?functionName"でヘルプページにアクセスすると、次の出力が "functionNameの開発ドキュメントを使用して"コンソールに出力されます。 devtoolsのgithubリポジトリから、この出力を与えるfunction dev-help.Rが見つかりました。コメントでは、この開発の助けを借りてリンクが機能しないと述べられています。

Note that this only renders a single documentation file, so that links to other files within the package won't work.

私はどのようにしてdev-helpの代わりに通常のドキュメントを使用できますか?

+1

[this](http://r-pkgs.had.co.nz/man.html#man-packages)を試しましたか?パッケージをどこかで見ることができますか? –

+0

私の意見では、これは自動的に追加されます。あなたはこれを試しましたか? 'devtools :: document("。 ")'を使用してください。 –

+0

@VincentBonhomme:これを試したところ、 "?packageName"でアクセスできるページが正常に作成されました。しかし、これはすべての関数(通常のインデックスページのような)を含んでおらず、関数のすべてのサブページからリンクされていないので、私たちの問題は解決しません。パッケージは現在、当社の内部パッケージであるため、残念ながらアクセスすることはできません。 – Malte

答えて

3

解決策が見つかりました。

  1. create()
  2. document()
  3. build()
  4. install.packages()
  5. library(<pkg-name>)

ドキュメントはdocument()中にRの名前空間にロードされます:あなたは、次のワークフローを使用している場合。したがって、?functionNameの後の呼び出しは、コンパイルされたパッケージによって提供されるものではなく、ドキュメンテーションの開発段階を指します。

したがって、インストール後に新しいRセッションを作成するだけで問題は解決します。

+0

よく出来た@Malte! –

+0

私はそれをinstall.packagesで動作させることができず、installを使用しなければなりませんでした。エラー:...使用できません(Rバージョン3.4.0) – Ferroao

関連する問題