2016-11-19 8 views
0

私はRでプログラミングを始める前に、サードパーティの関数名に不快感を感じました。はい、ドキュメントがありますが、機能の名前は読みにくいところに短縮されることがあります。関数ラッパーを使用した後のヘルプページへのリンクを維持する

すべての関数用の関数ラッパーを作成したいと思いますが、その名前は完全に判読できない傾向があります。それでも私はヘルプを呼び出せるようにしたい(つまり、RStudioのF1を押す)ことができます。

これを行う方法はありますか?

+0

ラッパーでパッケージを作成し、ラップされた関数のドキュメントのメイン関数ヘルプページへのリンクを追加します。 – hrbrmstr

+0

興味のあるものは、どのパッケージですか? –

答えて

1

私はあなたの痛みを感じるが、私は、これは、彼らがに慣れていない場合でも、コードが読みにくくなります誰ためしかし、あなた ためのラッパーを書くことが一般的にない良いアイデアだと思い元のライブラリ一つは、あなたの機能は完全に(Googleなどで)発見することができません。

さらに、コメントされているように、Rは、パッケージ化されていない関数がドキュメントを運ぶことを許可していません。独自のラッパーパッケージを生成する必要があります。その後、次のようにパッケージの内側に、あなたはあなたのエイリアスを定義することができます。

ある
#' @importFrom original_package orig_fct1 
readable_function1 = orig_fct1 

#' @importFrom original_package orig_fct2 
readable_function2 = orig_fct2 

# … etc 

、あなたは(とはないはずです)ラッパー関数を生成する必要はありません。エイリアスを定義するだけで十分です。 @importFrom Roxygenディレクティブは、ドキュメントを元の関数から継承します。


そして、「誰が、あなたは」数ヶ月の時間の中で自分自身が含まれています!

+0

_ "これは良い考えではなく、あなたの将来の自己は間違いなくあなたに満足していません。暗号化されていてもいなくても、名前を覚えたり、完全修飾された関数をタブで囲んで説明を見やすくするIDEを使用してください。 (例: 'pkgname :: functionname') – hrbrmstr

関連する問題