目次
Rのヘルプについて
Rは統計解析向けのプログラミング言語です。R標準のパッケージおよび外部パッケージともに、統計解析に役に立つ関数が多数提供されています。Rユーザーが新たな関数を初めて使うときに使い方などで戸惑わないようにヘルプ機能で手厚くサポートしてくれています。Rのヘルプ機能は入門者から上級者まで頻繁に活用する機能ですので、早いうちに習得しましょう。ここではRStudio上でRを実行しているものとして解説していきます。
関数のヘルプの表示の仕方
関数のヘルプを確認したいときには、「help()」または「?」を使用します。例えば、tidyverseパッケージにも含まれているdplyrパッケージのfilter()のヘルプを確認したいときには、RStudioの左下のコンソール領域で次のうち、いずれかを入力します。これらの4つのコマンドはすべて同じ意味です。
- help(filter)
- help(“filter”)
- ?filter
- ?”filter”
- help(filter, package = “dplyr”) （パッケージを明示的に指示したいとき）
すると、RStudioの右下のヘルプ領域に次のようにfilter()のヘルプが表示されます。実際には赤枠や赤いテキストは表示されませんが、これは以下の説明で用いるため付加しております。
関数のヘルプの見方
関数のヘルプは、おおよそのパターンが決まっています。特に、上の画像の赤枠で囲ったところはおおよそどの関数でも同じ箇所にあり、かつ重要な箇所となります。ここでは赤枠で囲ったところを解説していきます。
関数名とパッケージ名
R標準のパッケージおよび外部パッケージで提供されている関数は膨大であるため、たまに異なるパッケージだけれども同じ関数名という場合がありますので、ちらっとだけでも確認しておけば良いでしょう。
タイトル
タイトル欄に記載されている内容は、関数の簡潔な説明になります。
Description
Description欄に記載されている内容は、関数の説明になります。ここでの説明は、主にプログラミング向けではない内容になります。
Usage
Usage欄に記載されている内容は、関数の使い方になります。上の画像では一つしかありませんが、複数ある場合もあります。
Arguments
Arguments欄に記載されている内容は、引数の意味や引数のデータ型などが細かく記載されています。関数の使い方が複数ある場合も、引数はまとめてこの場所に記載されます。
Details
Details欄に記載されている内容は、関数の詳細な説明になります。ここでの説明は、主にプログラミング向けの内容になります。
Value
Value欄に記載されている内容は、関数の戻り値・返り値になります。
Examples
Examples欄に記載されている内容は、関数の例・サンプルコードになります。
lifecycleについて
ヘルプにlifecycleが記載されている場合があります。ここでは、lifecycleについて、解説します。
Stable
安定的であることを表します。安定的であるとは、破壊的変更を予定していないことであり、破壊的変更とは、関数への入力または関数からの出力が変更になることをいいます。簡単に言い換えると、パッケージのバージョンが上がってもちゃんとこのままにしておきます、というパッケージ開発者からパッケージ利用者へメッセージです。
Deprecated
非推奨であることを表します。非推奨であるとは、他のより優れた代替手段があり、削除が予定されていることです。簡単に言い換えると、今のバージョンでは使えるけれどバージョンが上がると使えなくなるから今のうちに他のより優れた代替手段の方を利用してください、というパッケージ開発者からパッケージ利用者へメッセージです。
Superseded
置き換えであることを表します。置き換えであるとは、他のより優れた代替手段があるが、削除が予定されていないことです。非推奨との違いは、今後、削除が予定されているか、削除が予定されていないかです。簡単に言い換えると、このまま使ってもいいけど、他のより優れた代替手段もあります、というパッケージ開発者からパッケージ利用者へメッセージです。
Experimental
実験的であることを表します。実験的であるとは、長期的な安定性を約束するものではなく非推奨であることを明示する前に破壊的変更を行う可能性があることを意味します。簡単に言い換えると、今後動作が変わるかもしれないから、使うときは自己責任で使ってください、というパッケージ開発者からパッケージ利用者へメッセージです。
Questioning
現在は、使用されていません。質問であることを表します。パッケージ開発者が関数の最適なアプローチであるかどうか確信が持てなくなったが、それをより適切に行う方法をまだ知らず、これらの関数を質問としてマークして、機能について疑問を持っていることをユーザーに知らせています。
Maturing
現在は、使用されていません。成熟であることを表します。以前は、実験的であることと安定的であることの間のどこかにある関数の成熟として使用していましたが、質問と同様に、このステージがどのような実用的な情報を提供するかが明確でないため使用されなくなりました。
関数のヘルプの活用方法
初めて使う関数の場合、ヘルプを上から下まで確認するのは重要だと思いますが、ひとまずExamples欄のサンプルコードをコピペして実行してみることをおすすめします。一般的にExamples欄のサンプルコードは、関数の特徴をとても短いコードで表しているので、関数の漠然とした感覚を掴んでから他の箇所を確認した方が効率的と思います。
