如何查看功能的源代码?


550

我想查看功能的源代码以了解其工作原理。我知道我可以通过在提示符下键入函数名称来打印该函数:

> 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。我如何找到这些源代码?




Answers:


518

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

“不可见的功能带有星号”表示该功能未从其程序包的命名空间中导出。您仍然可以通过:::函数(即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.

输出已经提供了很多信息。standardGeneric是S4功能的指示器。查看定义的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或内部R使用来完成解压缩和解压缩步骤untar()。可以将下载和扩展步骤组合为一个调用(请注意,每次只能通过这种方式下载和解压缩一个包):

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

另外,如果包开发是公开托管的(例如,通过GitHubR-ForgeRForge.net),则您可能可以在线浏览源代码。

基本包中的已编译代码

某些软件包被视为“基本”软件包。这些程序包随R和他们的版本被锁定到R.实例的版本包括basecompilerstats,和utils。因此,如上所述,它们不能作为CRAN上的单独可下载软件包使用。相反,它们是R源树中位于的单独程序包目录中的一部分/src/library/。下一节将介绍如何访问R源。

R解释器中内置的已编译代码

如果要查看R解释器内置的代码,则需要下载/解压缩R源。或者您可以通过R Subversion存储库Winston Chang的github镜像在线查看源代码。

Uwe Ligges的R新闻文章(PDF)(第43页)是如何查看.Internal.Primitive函数源代码的很好的一般参考。基本步骤是首先在中查找函数名称src/main/names.c,然后在中的文件中搜索“ C条目”名称src/main/*


71
如果您使用RStudio,则如果您按键,它将尝试拉出文本光标所在功能的源F2
阿里·弗里德曼

1
@Ari B. Friedman对不起,这个问题很抱歉。RStudio是否还会为该函数或仅为用R编写的函数提取C源代码?谢谢
2014年

3
@Samir我相信这只是R源。
Ari B. Friedman 2014年

@ AriB.Friedman-谢谢Ari,这很方便。就我而言,我仍然需要答案中显示的知识(scale,即S3-我获得UseMethod("scale")并使用getAnywhere(scale.default))。但是普通功能可以正常工作。
Tomasz Gandor

2
模仿是最恭维的奉承形式,我认为这个答案/维基是最先出现的:)在此rfaqs.com/source-code-of-r-method
JimLohse18年

94

除了此问题的其他答案及其重复项之外,这也是一种获取软件包功能源代码的好方法,而无需知道其位于哪个软件包中。例如,如果我们想要以下代码的源代码randomForest::rfcv()

要在弹出窗口中查看/编辑它:

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

重定向到一个单独的文件

capture.output(getAnywhere('rfcv'), file='source_rfcv.r')

诚然,对于应该被称为findOnSearchPath或类似名称的东西,getAnywhere是另一个古怪的R名称选择。
smci 2015年

1
我会回答这个问题,因为它使我接近了想要的结果。在RStudio中,我真正想要的是View(foo)foo来自已加载包的函数在哪里。
Sigfried

1
@Sigfried:edit()打开一个文本编辑器(由用户选择),而View()打开一个Excel类型的电子表格查看器来存储数据,后者对于浏览(多列)数据非常有用,但通常对于除玩具长度以外的任何代码都非常糟糕。例如,正如我所暗示的那样,浏览功能时,我通常要做的第一件事是跳过/折叠/虚拟所有arg解析和默认操作逻辑,以了解该功能的实际作用
smci

25

使用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()


与接受的答案相比,该方法的缺点是您需要一个工作函数调用(所有必需的参数都可以接受地指定);而且,除了最初的代码块之外,您还可以在运行时获得每个块。这对于调试非常有用,但对于仅获取源代码而言并不是最佳选择。
Brian Diggs 2014年

是的,它不是最佳的。但是,如果您很聪明,则可以快速而轻松地获取源代码,尤其是内置函数。
塞尔瓦2014年

2
我还建议在这种情况下使用debugonce代替debug
约书亚·乌尔里希

20

对于非原始函数,R base包含一个称为的函数,该函数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,其中class(x) = "foo")。列表成员之一(名为“ fun”)是一个函数,我想print.foo()显示缩进的函数源代码。因此,我最终获得了以下代码段print.foo()

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

缩进并显示与相关的代码x[["fun"]]


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("%%")

主要答案包括如何使用镜子进行更深入的研究。


6
推荐smci的答案getAnywhere。或者,如果您已经知道运算符的名称,则可以使用反引号:`%in%`
约书亚·乌尔里希

3
@JoshuaUlrich不知道您可以使用反引号!谢谢。getAnywhere在您的答案中也提到了,但是我认为对infix的特定引用对于将来对此答案的引用很有用-我已经阅读了很多次此页面,并且仍然试图为此类函数查找代码仍然有些困惑一会儿-我认为它不适合其他任何答案(它们都getAnywhere用于其他目的)。
MichaelChirico 2015年

10

R中有一个非常方便的功能 edit

new_optim <- edit(optim)

它将optim使用R中指定的编辑器打开源代码options,然后您可以对其进行编辑并将修改后的功能分配给new_optim。我非常喜欢此功能来查看代码或调试代码,例如,打印一些消息或变量,甚至将它们分配给全局变量以进行进一步研究(当然您可以使用debug)。

如果您只想查看源代码,而又不想在控制台上打印烦人的长源代码,则可以使用

invisible(edit(optim))

显然,这不能用于查看C / C ++或Fortran源代码。

BTW edit可以打开其他对象,如列表,矩阵等,然后显示具有属性的数据结构。该函数de可用于打开excel之类的编辑器(如果GUI支持),以修改矩阵或数据框并返回新的。有时这很方便,但是在通常情况下应避免使用,特别是当矩阵较大时。


3
这种方法只调出与打印函数所提供的函数源相同的函数(即与问题中的函数源相同)。比这个问题更进一步/更深入。
Brian Diggs 2014年

2
@BrianDiggs是的,您是对的。我并不是要回答这个问题,因为约书亚给出了相当完整的答案。我只是尝试添加与该主题相关的内容,这些有趣的内容可能对您有所帮助。
埃里克


7

在RStudio中,至少有3种方式:

  1. 当光标位于任何功能上时,按F2键。
  2. 按住Ctrl或Command的同时单击函数名称
  3. View(函数名)(如上所述)

将打开一个包含源代码的新窗格。如果您达到.Primitive或.C,则需要另一种方法,对不起。


5

View([function_name])-例如 View(mean)确保使用大写[V]。只读代码将在编辑器中打开。


5

您也可以尝试使用print.function()S3通用的来在控制台中编写函数。


3
print.function()是S3 方法。泛型为print()。直接调用方法通常不是一个好主意。这破坏了通用函数和方法分配的全部目的。
Joshua Ulrich
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.