R言語のヘルプの使い方について解説します。
Rを使っていると関数やパッケージの使用方法が分からなく困る時が多々あります。
関数helpを使うことで関数やパッケージの用途や使用例を見ることができます。
解析をしていて関数の使い方が分からなくなったときに非常に便利です。
Rのヘルプ
次の関数helpを使うことでRのヘルプを参照することが可能です。
ヘルプには関数の引数の説明や使用例などの詳細が書かれています。また、関数だけでなくパッケージやデータセットなどのヘルプも読むことができます。
help(topic, package = NULL, lib.loc = NULL, verbose = getOption("verbose"), try.all.packages = getOption("help.try.all.packages"), help_type = getOption("help_type"))
関数helpの引数は以下の通りです。
| 引数 | 説明 |
| topic | ヘルプを参照したい対象の名前またはcharacter型。 |
| package | ヘルプを参照する対象のパッケージの名前またはcharacter型またはNULL。デフォルトで読み込まれているパッケージが用いられる。 |
| lib.loc | Rライブラリのディレクトリ名を表すcharacter型のベクトルまたはNULL。デフォルトのNULLは現在のすべてのライブラリに対応する。 |
| verbose | logical型。TRUEの場合、ファイル名が返される。 |
| try.all.package | logical型。TRUEの場合、インストールされているすべてのパッケージを検索対象にする。 |
| help_type | character型。ヘルプのファイルの種類を指定する。"txt"、"html"、"pdf"でそれぞれに対応したファイルのヘルプを参照できる。 |
実行例
ヘルプの参照例をいくつか紹介します。
関数helpを用いることで、ドキュメントが存在するすべてのオブジェクト、関数、パッケージなどのヘルプを参照することが可能です。
次の例はデータセットirisのヘルプを参照しています。
使い方は関数helpの引数topicにヘルプを参照したい対象の名前を渡すだけです。
1 | help("iris") |
help オブジェクト
また、helpの引数topicに関数名を渡すことで、関数のヘルプを出力することができます。
1 | help("mean") |
help 関数
さらにオブジェクトや関数だけでなくパッケージのヘルプを参照することも可能です。
helpの引数topicにパッケージ名を渡す方法のほかに、引数packageを対象のパッケージ名にすることで実現できます。
引数topicを用いた場合だと一つ目の画像のように単純なパッケージのドキュメントが表示されます。
引数packageを用いた場合だと、パッケージに含まれているすべての情報がまとめられたページを参照することができます。
1 2 | help("stats") help(package = "stats") |
help パッケージ1
help パッケージ2
また、あるパッケージ内の関数やオブジェクトのヘルプを参照したいときは、引数packageに参照する対象のパッケージを渡し、topicに関数やオブジェクトの名前を渡します。
複数のパッケージ間で、同じ名前の関数やオブジェクトがある場合に用います。
1 | help("na.omit", package = "stats") |
パッケージを指定した方法
まとめ
Rのヘルプの参照の仕方を見てきました。
関数helpで関数、パッケージ、データセットなどのあらゆるRのオブジェクトのヘルプを参照することが可能です。
関数やパッケージの使い方が分からなくなったときに便利です。
