関数のソースコードを表示するにはどうすればよいですか?

583
Joshua Ulrich 2013-10-08 03:58.

関数のソースコードを見て、どのように機能するかを確認したいと思います。プロンプトで名前を入力することで関数を印刷できることを知っています。

> t
function (x) 
UseMethod("t")
<bytecode: 0x2332948>
<environment: namespace:base>

この場合、どういうUseMethod("t")意味ですか?たとえば、実際に使用されているソースコードを見つけるにはどうすればよいt(1:10)ですか?

私が見たときとの間に差があるUseMethodと、私が見たときstandardGenericshowMethods場合と同様に、with

> with
standardGeneric for "with" defined from package "base"

function (data, expr, ...) 
standardGeneric("with")
<bytecode: 0x102fb3fc0>
<environment: 0x102fab988>
Methods may be defined for arguments: data
Use  showMethods("with")  for currently available ones.

その他の場合、R関数が呼び出されていることはわかりますが、それらの関数のソースコードが見つかりません。

> ts.union
function (..., dframe = FALSE) 
.cbind.ts(list(...), .makeNamesTs(...), dframe = dframe, union = TRUE)
<bytecode: 0x36fbf88>
<environment: namespace:stats>
> .cbindts
Error: object '.cbindts' not found
> .makeNamesTs
Error: object '.makeNamesTs' not found

.cbindtsおよびのような関数を見つけるにはどうすればよい.makeNamesTsですか?

さらに他のケースでは、Rコードが少しありますが、ほとんどの作業は別の場所で行われているようです。

> matrix
function (data = NA, nrow = 1, ncol = 1, byrow = FALSE, dimnames = NULL) 
{
    if (is.object(data) || !is.atomic(data)) 
        data <- as.vector(data)
    .Internal(matrix(data, nrow, ncol, byrow, dimnames, missing(nrow), 
        missing(ncol)))
}
<bytecode: 0x134bd10>
<environment: namespace:base>
> .Internal
function (call)  .Primitive(".Internal")
> .Primitive
function (name)  .Primitive(".Primitive")

.Primitive関数が何をするのかを知るにはどうすればよいですか?同様に、一部の機能が呼び出す.C.Call.Fortran.External、または.Internal。それらのソースコードを見つけるにはどうすればよいですか?

10 answers

534
Joshua Ulrich 2013-10-08 03:58.

UseMethod("t")は、さまざまなオブジェクトクラスのメソッドを持つt()S3)ジェネリック関数であることを示しています。

S3メソッドディスパッチシステム

S3クラスの場合、methods関数を使用して、特定の汎用関数またはクラスのメソッドを一覧表示できます。

> methods(t)
[1] t.data.frame t.default    t.ts*       

   Non-visible functions are asterisked
> methods(class="ts")
 [1] aggregate.ts     as.data.frame.ts cbind.ts*        cycle.ts*       
 [5] diffinv.ts*      diff.ts          kernapply.ts*    lines.ts        
 [9] monthplot.ts*    na.omit.ts*      Ops.ts*          plot.ts         
[13] print.ts         time.ts*         [<-.ts*          [.ts*           
[17] t.ts*            window<-.ts*     window.ts*      

   Non-visible functions are asterisked

「非表示の関数にはアスタリスクが付いています」とは、関数がパッケージの名前空間からエクスポートされていないことを意味します。:::関数(ie stats:::t.ts)を使用するか、を使用して、ソースコードを表示できgetAnywhere()ます。 getAnywhere()関数がどのパッケージから来たのかを知る必要がないので便利です。

> getAnywhere(t.ts)
A single object matching ‘t.ts’ was found
It was found in the following places
  registered S3 method for t from namespace stats
  namespace:stats
with value

function (x) 
{
    cl <- oldClass(x)
    other <- !(cl %in% c("ts", "mts"))
    class(x) <- if (any(other)) 
        cl[other]
    attr(x, "tsp") <- NULL
    t(x)
}
<bytecode: 0x294e410>
<environment: namespace:stats>

S4方式ディスパッチシステム

S4システムは、新しいメソッドディスパッチシステムであり、S3システムの代替です。S4関数の例を次に示します。

> library(Matrix)
Loading required package: lattice
> chol2inv
standardGeneric for "chol2inv" defined from package "base"

function (x, ...) 
standardGeneric("chol2inv")
<bytecode: 0x000000000eafd790>
<environment: 0x000000000eb06f10>
Methods may be defined for arguments: x
Use  showMethods("chol2inv")  for currently available ones.

出力はすでに多くの情報を提供しています。standardGenericS4機能の指標です。定義されたS4メソッドを表示するメソッドが役立ちます。

> showMethods(chol2inv)
Function: chol2inv (package base)
x="ANY"
x="CHMfactor"
x="denseMatrix"
x="diagonalMatrix"
x="dtrMatrix"
x="sparseMatrix"

getMethod 次のいずれかの方法のソースコードを確認するために使用できます。

> getMethod("chol2inv", "diagonalMatrix")
Method Definition:

function (x, ...) 
{
    chk.s(...)
    tcrossprod(solve(x))
}
<bytecode: 0x000000000ea2cc70>
<environment: namespace:Matrix>

Signatures:
        x               
target  "diagonalMatrix"
defined "diagonalMatrix"

たとえば、メソッドごとにさらに複雑なシグネチャを持つメソッドもあります。

require(raster)
showMethods(extract)
Function: extract (package raster)
x="Raster", y="data.frame"
x="Raster", y="Extent"
x="Raster", y="matrix"
x="Raster", y="SpatialLines"
x="Raster", y="SpatialPoints"
x="Raster", y="SpatialPolygons"
x="Raster", y="vector"

これらのメソッドのいずれかのソースコードを表示するには、署名全体を指定する必要があります。

getMethod("extract" , signature = c( x = "Raster" , y = "SpatialPolygons") )

部分的な署名を提供するだけでは不十分です

getMethod("extract",signature="SpatialPolygons")
#Error in getMethod("extract", signature = "SpatialPolygons") : 
#  No method found for function "extract" and signature SpatialPolygons

エクスポートされていない関数を呼び出す関数

以下の場合はts.union.cbindtsおよび.makeNamesTsからアンエクスポート機能しているstats名前空間。:::演算子またはを使用して、エクスポートされていない関数のソースコードを表示できますgetAnywhere

> stats:::.makeNamesTs
function (...) 
{
    l <- as.list(substitute(list(...)))[-1L]
    nm <- names(l)
    fixup <- if (is.null(nm)) 
        seq_along(l)
    else nm == ""
    dep <- sapply(l[fixup], function(x) deparse(x)[1L])
    if (is.null(nm)) 
        return(dep)
    if (any(fixup)) 
        nm[fixup] <- dep
    nm
}
<bytecode: 0x38140d0>
<environment: namespace:stats>

コンパイルされたコードを呼び出す関数

「コンパイル済み」とは、コンパイラパッケージによって作成されたバイトコンパイル済みのRコードを指すものではないことに注意してください。<bytecode: 0x294e410>上記の出力の行は、関数がバイトコンパイルされていることを示しており、Rコマンドラインからソースを表示できます。

機能その呼び出し.C.Call.Fortran.External.Internal、または.Primitiveあなたが完全に機能を理解したい場合は、コンパイルされたコードのソースを見てする必要がありますので、コンパイルされたコードにエントリーポイントを呼び出しています。RソースコードのこのGitHubミラーは、開始するのに適切な場所です。この関数pryr::show_c_sourceは、GitHubページに直接移動して呼び出すため、便利なツールに.Internalなり.Primitiveます。パッケージには、使用することができ.C.Call.Fortran、と.External。ただし、.Internalまたは.Primitiveではありません。これらは、Rインタープリターに組み込まれている関数を呼び出すために使用されるためです。

上記の関数の一部の呼び出しでは、コンパイルされた関数を参照するために、文字列の代わりにオブジェクトを使用する場合があります。そのような場合、オブジェクトは、クラスのものである"NativeSymbolInfo""RegisteredNativeSymbol"または"NativeSymbol"、オブジェクトを印刷すると、有用な情報が得られます。たとえば、optim呼び出し.External2(C_optimhess, res$par, fn1, gr1, con)C_optimhessではなく、であることに注意してください"C_optimhess")。 optimはstatsパッケージに含まれているため、入力stats:::C_optimhessして、呼び出されているコンパイル済み関数に関する情報を確認できます。

パッケージ内のコンパイルされたコード

コンパイルされたコードをパッケージで表示する場合は、パッケージソースをダウンロード/解凍する必要があります。インストールされているバイナリでは不十分です。パッケージのソースコードは、パッケージが最初にインストールされたのと同じCRAN(またはCRAN互換)リポジトリから入手できます。このdownload.packages()関数は、パッケージソースを取得できます。

download.packages(pkgs = "Matrix", 
                  destdir = ".",
                  type = "source")

これにより、Matrixパッケージのソースバージョンがダウンロードされ、対応する.tar.gzファイルが現在のディレクトリに保存されます。コンパイルされた関数のソースコードsrcは、圧縮されていない、風袋引きされていないファイルのディレクトリにあります。解凍と風袋引きの手順は、関数を使用してR、の外部または内部から実行できます。ダウンロードと拡張のステップを1つの呼び出しに組み合わせることができます(この方法でダウンロードおよび解凍できるパッケージは一度に1つだけであることに注意してください)。Runtar()

untar(download.packages(pkgs = "Matrix",
                        destdir = ".",
                        type = "source")[,2])

または、パッケージ開発がパブリックにホストされている場合(GitHubR-ForgeRForge.netなど)、ソースコードをオンラインで閲覧できます。

基本パッケージでコンパイルされたコード

特定のパッケージは「基本」パッケージと見なされます。これらのパッケージはRで出荷し、そのバージョンが含まR.例のバージョンにロックされているbasecompilerstats、とutils。そのため、上記のようにCRANで個別にダウンロード可能なパッケージとして利用することはできません。むしろ、それらは/src/library/。の下の個々のパッケージディレクトリのRソースツリーの一部です。Rソースにアクセスする方法については、次のセクションで説明します。

Rインタープリターに組み込まれたコンパイル済みコード

Rインタープリターに組み込まれているコードを表示する場合は、Rソースをダウンロード/解凍する必要があります。または、RSubversionリポジトリまたはWinstonChangのgithubミラーを介してオンラインでソースを表示できます。

Uwe LiggesのRニュース記事(PDF)(p。43 )は、.Internalおよび.Primitive関数のソースコードを表示する方法の優れた一般的なリファレンスです。基本的な手順は、最初にで関数名をsrc/main/names.c検索し、次にのファイルで「Cエントリ」名を検索することですsrc/main/*

100
smci 2014-05-23 12:46.

この質問とその重複上の他の回答に加えて、ここではそれがでますどのパッケージ知らなくても、パッケージの機能のためのソースコードを入手するには良いの方法です私たちはソースをしたい場合などは言います。randomForest::rfcv()

表示/編集ポップアップウィンドウでそれを:

edit(getAnywhere('rfcv'), file='source_rfcv.r')

View(getAnywhere('rfcv'), file='source_rfcv.r')

edit()(ユーザーが選択した)テキストエディタを開き View()ますが、スプレッドシートスタイルのデータビューアを呼び出すことに注意してください。

  • View()(複数列の)データの閲覧には最適ですが、通常、おもちゃの長さ以外のコードにはひどいものです。
  • したがって、コードのみを表示したい場合、edit()IMOは実際にはよりもはるかに優れView()ていedit()ます。これを使用すると、R関数の最大70%を占める可能性のあるすべての引数解析/チェック/デフォルト/エラーメッセージロジックを折りたたむ/非表示にする/ダミーにすることができます、そして関数が実際に何かを実行する部分(!)、戻り値の型がどのタイプのオブジェクトであるか、再帰するかどうか、どのように再帰するかなどに到達します。

するには、別のファイルにリダイレクト(あなたのお気に入りのIDE /エディタでコードを持ち出すことができるように/ etc grepを/でそれを処理します。):

capture.output(getAnywhere('rfcv'), file='source_rfcv.r')
26
Selva 2014-08-12 21:01.

debug()関数を使用してデバッグすると表示されます。t()転置関数の基礎となるコードを見たいとしましょう。「t」と入力するだけでは、あまりわかりません。

>t 
function (x) 
UseMethod("t")
<bytecode: 0x000000003085c010>
<environment: namespace:base>

ただし、「debug(functionName)」を使用すると、基礎となるコードが明らかになり、内部がなくなります。

> debug(t)
> t(co2)
debugging in: t(co2)
debug: UseMethod("t")
Browse[2]> 
debugging in: t.ts(co2)
debug: {
    cl <- oldClass(x)
    other <- !(cl %in% c("ts", "mts"))
    class(x) <- if (any(other)) 
        cl[other]
    attr(x, "tsp") <- NULL
    t(x)
}
Browse[3]> 
debug: cl <- oldClass(x)
Browse[3]> 
debug: other <- !(cl %in% c("ts", "mts"))
Browse[3]> 
debug: class(x) <- if (any(other)) cl[other]
Browse[3]>  
debug: attr(x, "tsp") <- NULL
Browse[3]> 
debug: t(x)

編集: debugonce()はundebug()を使用せずに同じことを達成します

22
Geoffrey Poole 2016-12-31 11:41.

非プリミティブ関数の場合、Rベースには、関数body()の本体を返すと呼ばれる関数が含まれます。たとえば、print.Date()関数のソースを表示できます。

body(print.Date)

これを生成します:

{
    if (is.null(max)) 
        max <- getOption("max.print", 9999L)
    if (max < length(x)) {
        print(format(x[seq_len(max)]), max = max, ...)
        cat(" [ reached getOption(\"max.print\") -- omitted", 
            length(x) - max, "entries ]\n")
    }
    else print(format(x), max = max, ...)
    invisible(x)
}

スクリプトで作業していて、関数コードを文字ベクトルとして使用したい場合は、それを取得できます。

capture.output(print(body(print.Date)))

あなたを取得します:

[1] "{"                                                                   
[2] "    if (is.null(max)) "                                              
[3] "        max <- getOption(\"max.print\", 9999L)"                      
[4] "    if (max < length(x)) {"                                          
[5] "        print(format(x[seq_len(max)]), max = max, ...)"              
[6] "        cat(\" [ reached getOption(\\\"max.print\\\") -- omitted\", "
[7] "            length(x) - max, \"entries ]\\n\")"                      
[8] "    }"                                                               
[9] "    else print(format(x), max = max, ...)"                           
[10] "    invisible(x)"                                                    
[11] "}"     

なぜそんなことをしたいのですか?リストに基づいてカスタムS3オブジェクト(x、where class(x) = "foo")を作成していました。リストメンバーの1つ(「fun」という名前)は関数でありprint.foo()、関数のソースコードをインデントして表示したいと思いました。だから私は次のスニペットになってしまいましたprint.foo()

sourceVector = capture.output(print(body(x[["fun"]])))
cat(paste0("      ", sourceVector, "\n"))

に関連付けられたコードをインデントして表示しますx[["fun"]]

18
MichaelChirico 2015-12-02 10:18.

これが主な答えの流れにどのように適合するかはわかりませんでしたが、しばらくの間私を困惑させたので、ここに追加します:

中置演算子

いくつかの基本中置演算子(例えば、のソースコードを参照するには%%%*%%in%)、使用getAnywhere、例えば:

getAnywhere("%%")
# A single object matching ‘%%’ was found
# It was found in the following places
#   package:base
#   namespace:base
#  with value
#
# function (e1, e2)  .Primitive("%%")

主な答えは、ミラーを使用してより深く掘り下げる方法をカバーしています。

10
Eric 2014-12-05 13:39.

Rには非常に便利な機能があります edit

new_optim <- edit(optim)

optimRで指定したエディタを使用したソースコードを開き、options編集して変更した関数をに割り当てることができますnew_optim。この関数は、コードを表示したり、コードをデバッグしたりするのに非常に気に入っています。たとえば、メッセージや変数を出力したり、さらに調査するためにグローバル変数に割り当てたりすることもできます(もちろん使用できますdebug)。

ソースコードを表示したいだけで、面倒な長いソースコードをコンソールに出力したくない場合は、次を使用できます。

invisible(edit(optim))

明らかに、これを使用してC / C ++またはFortranのソースコードを表示することはできません。

ところで、editリスト、マトリックスなどの他のオブジェクトを開くことができます。これにより、データ構造と属性も表示されます。関数deを使用して、Excelのようなエディター(GUIがサポートしている場合)を開いて、行列またはデータフレームを変更し、新しいものを返すことができます。これは便利な場合もありますが、通常の場合、特にマトリックスが大きい場合は避ける必要があります。

8
MCH 2017-01-25 06:42.

関数がC / C ++ / Fortranではなく純粋なRで記述されている限り、次のものを使用できます。それ以外の場合は最良の方法はされてデバッグ「を使用してとジャンプ 」:

> functionBody(functionName)
7
Arthur Yip 2019-02-23 04:54.

RStudioには、(少なくとも)3つの方法があります。

  1. カーソルが任意の機能にあるときにF2キーを押します。
  2. CtrlキーまたはCommandキーを押しながら関数名をクリックします
  3. View(function_name)(上記のとおり)

ソースコードを含む新しいペインが開きます。.Primitiveまたは.Cに到達した場合は、別の方法が必要になります。申し訳ありません。

5
strboul 2017-12-27 01:45.

print.function()S3ジェネリックであるを使用して、コンソールで関数writeを取得することもできます。

5
Koo 2017-01-11 16:45.

View(function_name)-例:View(mean)必ず大文字の[V]を使用してください。読み取り専用コードがエディターで開きます。

Related questions

MORE COOL STUFF

Reba McEntire は、彼女が息子の Shelby Blackstock と共有する「楽しい」クリスマスの伝統を明らかにしました:「私たちはたくさん笑います」

Reba McEntire は、彼女が息子の Shelby Blackstock と共有する「楽しい」クリスマスの伝統を明らかにしました:「私たちはたくさん笑います」

Reba McEntire が息子の Shelby Blackstock と共有しているクリスマスの伝統について学びましょう。

メーガン・マークルは、自然な髪のスタイリングをめぐってマライア・キャリーと結ばれました

メーガン・マークルは、自然な髪のスタイリングをめぐってマライア・キャリーと結ばれました

メーガン・マークルとマライア・キャリーが自然な髪の上でどのように結合したかについて、メーガンの「アーキタイプ」ポッドキャストのエピソードで学びましょう.

ハリー王子は家族との関係を修復できるという「希望を持っている」:「彼は父親と兄弟を愛している」

ハリー王子は家族との関係を修復できるという「希望を持っている」:「彼は父親と兄弟を愛している」

ハリー王子が家族、特にチャールズ王とウィリアム王子との関係について望んでいると主張したある情報源を発見してください。

ワイノナ・ジャッドは、パニックに陥った休暇の瞬間に、彼女がジャッド家の家長であることを認識しました

ワイノナ・ジャッドは、パニックに陥った休暇の瞬間に、彼女がジャッド家の家長であることを認識しました

ワイノナ・ジャッドが、母親のナオミ・ジャッドが亡くなってから初めての感謝祭のお祝いを主催しているときに、彼女が今では家長であることをどのように認識したかを学びましょう.

セントヘレナのジェイコブのはしごを登るのは、気弱な人向けではありません

セントヘレナのジェイコブのはしごを登るのは、気弱な人向けではありません

セント ヘレナ島のジェイコブズ ラダーは 699 段の真っ直ぐ上る階段で、頂上に到達すると証明書が発行されるほどの難易度です。

The Secrets of Airline Travel Quiz

The Secrets of Airline Travel Quiz

Air travel is far more than getting from point A to point B safely. How much do you know about the million little details that go into flying on airplanes?

Where in the World Are You? Take our GeoGuesser Quiz

Where in the World Are You? Take our GeoGuesser Quiz

The world is a huge place, yet some GeoGuessr players know locations in mere seconds. Are you one of GeoGuessr's gifted elite? Take our quiz to find out!

バイオニック読書はあなたをより速く読むことができますか?

バイオニック読書はあなたをより速く読むことができますか?

BionicReadingアプリの人気が爆発的に高まっています。しかし、それは本当にあなたを速読術にすることができますか?

世界最小のマルチツールを15ドルでキーチェーンに追加

世界最小のマルチツールを15ドルでキーチェーンに追加

爪| $ 15 | マルボロ&ケインザクロー| $ 15 | Malboro&Kane世界最小のマルチツールであるTheClawをたった15ドルで手に入れましょう。男の子と一緒に冷たいものを割って開けたり、ネジを締めたり、Amazonパッケージを細断したりする場合でも、この悪い男の子はこれまでで最も便利な製品の1つです。

ワンダーウーマンの続編の悪役についてのより多くの噂

ワンダーウーマンの続編の悪役についてのより多くの噂

ワンダーウーマンとしてのガル・ガドット。WaywardPinesは正式に終了しました。

42,000試合で作られた球がスローモーションで燃えるのを見るのは魅力的な光景です

42,000試合で作られた球がスローモーションで燃えるのを見るのは魅力的な光景です

人が2つのマッチを接着するように導くものは何ですか?何があなたをマッチに打ち続け、構造が湾曲していることを発見するのですか?42,000のボールを作るまで、試合を続けなければならない理由は何ですか?しかし、何よりも、これほど魅力的なショーである可能性はどのようにありますか?私はあなたをだますつもりはありません、次に私たちがあなたに残すのは、あなたや私のような人が自由な時間を過ごすことを決定するビデオですボールを作るために必要な試合数を確認します(答えは42です。

サクラメントビーが1950万人のカリフォルニア州の有権者記録を漏らし、ハッカーによって即座に侵害された

サクラメントビーが1950万人のカリフォルニア州の有権者記録を漏らし、ハッカーによって即座に侵害された

写真:AP先月、カリフォルニアの地元新聞が1,900万件以上の有権者記録をオンラインで公開しました。Gizmodoは今週、明らかなランサムウェア攻撃中にレコードが侵害されたことを確認しました。

米国のフィギュア スケートは、チーム イベントでの最終決定の欠如に「苛立ち」、公正な裁定を求める

米国のフィギュア スケートは、チーム イベントでの最終決定の欠如に「苛立ち」、公正な裁定を求める

ロシアのフィギュアスケーター、カミラ・バリエバが関与したドーピング事件が整理されているため、チームは2022年北京冬季オリンピックで獲得したメダルを待っています。

Amazonの買い物客は、わずか10ドルのシルクの枕カバーのおかげで、「甘やかされた赤ちゃんのように」眠れると言っています

Amazonの買い物客は、わずか10ドルのシルクの枕カバーのおかげで、「甘やかされた赤ちゃんのように」眠れると言っています

何千人ものAmazonの買い物客がMulberry Silk Pillowcaseを推奨しており、現在販売中. シルクの枕カバーにはいくつかの色があり、髪を柔らかく肌を透明に保ちます。Amazonで最大46%オフになっている間にシルクの枕カバーを購入してください

パデュー大学の教授が覚醒剤を扱った疑いで逮捕され、女性に性的好意を抱かせる

パデュー大学の教授が覚醒剤を扱った疑いで逮捕され、女性に性的好意を抱かせる

ラファイエット警察署は、「不審な男性が女性に近づいた」という複数の苦情を受けて、12 月にパデュー大学の教授の捜査を開始しました。

コンセプト ドリフト: AI にとって世界の変化は速すぎる

コンセプト ドリフト: AI にとって世界の変化は速すぎる

私たちの周りの世界と同じように、言語は常に変化しています。以前の時代では、言語の変化は数年または数十年にわたって発生していましたが、現在では数日または数時間で変化する可能性があります。

SF攻撃で91歳のアジア人女性が殴られ、コンクリートに叩きつけられた

犯罪擁護派のオークランドが暴力犯罪者のロミオ・ロレンゾ・パーハムを釈放

SF攻撃で91歳のアジア人女性が殴られ、コンクリートに叩きつけられた

認知症を患っている 91 歳のアジア人女性が最近、47 番街のアウター サンセット地区でロメオ ロレンゾ パーハムに襲われました。伝えられるところによると、被害者はサンフランシスコの通りを歩いていたところ、容疑者に近づき、攻撃を受け、暴行を受けました。

ℝ

“And a river went out of Eden to water the garden, and from thence it was parted and became into four heads” Genesis 2:10. ? The heart is located in the middle of the thoracic cavity, pointing eastward.

メリック・ガーランドはアメリカに失敗しましたか?

バイデン大統領の任期の半分以上です。メリック・ガーランドは何を待っていますか?

メリック・ガーランドはアメリカに失敗しましたか?

人々にチャンスを与えることは、人生で少し遅すぎると私は信じています。寛大に。

Language