@ Rプログラミング、またはRマークダウンの使用？

-2

私は別のプログラマからコードをダウンロードして、彼らは次のようにあります@ Rプログラミング、またはRマークダウンの使用？

#' @param gr    a GRanges of regions/DMRs/whatever 
#' @param HMM    a GRanges with ChromHMM annotations (name, itemRgb) 
#' @param background  a null distribution (universe) whence gr was chosen 
#' @param footprint   compute BP footprints instead of number of overlaps? 
#' 
#' @return     a data.frame with overlap frequency and color code 
#' 
#' @export

私はknitrスピンから構文として」＃を認識しています。しかし、私はそれがここでどのように使用されているのか、シンボルが何をしているのか理解していません。説明してください。

出典

2017-01-30 Gaius Augustus

パッケージのドキュメントについては[こちら]（http://r-pkgs.had.co.nz）を参照し、** roxygen2 **パッケージを参照してください。 – joran

ありがとうございます。私はこれがパッケージのためのものであるということを知らなかった。私はパッケージのドキュメントを見ることを考えていないだろう。情報は私の現在のレベルで私にとっては理解するのが少し難しいですが、私はそれを続けます。 Googleが@記号を入れていることを私が理解していなかったので、オンラインでそれを見ることはできませんでした。 –

#'の部分は、これがRパッケージroxygen2を介して適切なRドキュメントに織り込まれていることを示しています。 @paramは、これらのことをドキュメントの要素にするよう翻訳者に指示しています。あなたが投稿

例は、最終的に節の引数の下で使用?functionNameの部分と各引数の説明の下

functionName(gr, HMM, background, footprint)

と見ることのように...リンク@joranが提供くださいますヘルプファイルを作成します。（およびstackoverflow tag description）を使用して、このインラインドキュメントが完全に壊れた.Rdファイルになる方法をガイドするのに使用できるすべてのタグについて説明します。

出典

2017-01-30 23:30:20

これは私の協力者（コードを書いた人）が、要求に応じてレンダリングするドキュメント（つまり、 '？functionName'をコンソールに入力した人）がカスタム関数を作成したことを意味します。私は、roxygen2パッケージと提供されたリンクに関する多くの資料を読みました。私はまだ完全に理解していませんが、これは非常に役に立ちます。他人が使用できるカスタム関数を書く場合、これは私がやるべきことですか？ –

@GaiusAugustus Rで '？functionName'を利用できるようにするには、パッケージを作成する必要があります（ドキュメントはプロセスの一部に過ぎません）。あなたの協力者が現在行っていることはおそらく現在、あなたがパッケージを作ることに決めたら、ビネットも良い方法です。 –

@ Rプログラミング、またはRマークダウンの使用？

答えて

関連する問題