コメントをカスタム関数から表示する方法

Question

RStudioを使用しています。私は、関数を呼び出すときにタブを押すことができ、選択可能なパラメータでポップアップが表示されることに気付きました。 round(と入力してヒットタブを押すと、x=とdigits=が選択肢として表示されます。これは、私が書いたカスタム関数でも起こります。違いは、組み込み関数のポップアップにも、個々のパラメータに関するコメントと説明があることです。カスタム関数でもこのような振る舞いを再現することは可能ですか？

Answer 1

私はあなたが何を意味するかを見ます。あなたは

foo = function(x,y) { ... } 

カスタマイズ機能を記述する場合、あなたはfoo(を行くと、タブを打つ、コード補完ポップアップメニューは、あなたのオプションx =とy =を与えるだろう。ただし、既存のR機能などround(を入力すると、だけでなく、タブはあなたに選択肢を与えるが、説明はあなたの機能におけるその役割言って、各変数の下にありますん：

唯一の方法私は独自の関数でこれを行うことは、独自のカスタマイズされたパッケージに関数をパッケージ化し、 "ヘルプ"ドキュメントに関数のパラメータが含まれていることを確認することです。これは、stackoverflowの質問の領域を超えていますが、Rパッケージの基礎を学んだ2つのブログを紹介します。

Not So Standard Deviationブログは、あなたのカスタマイズされた機能はRStudioのオートコンプリート内部の説明に表示されために必要なものを正確であるヘルプドキュメント、とシンプルなパッケージの作成方法を説明します。一言で言えば、あなたはdevtools、roxygen2をインストールする必要がありますと、それぞれのカスタマイズされた機能で、あなたは徹底的にこのような関数をコメントアウトする必要があります：

（免責事項：間抜けな猫の一例ですブロガーのものではなく、私のものではありません）

Here's a more detailed tutorialRパッケージの作成についてはこちら、another blog on getting organised with R packagesです。がんばろう！