638

我想查看一个函数的源代码,看看它是如何工作的。我知道我可以通过在提示符处输入函数名称来打印函数:

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

在这种情况下,是什么UseMethod("t")意思?如何找到实际使用的源代码,例如:t(1:10)

UseMethod当我看到和当我看到standardGenericandshowMethods之间有区别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. 我怎样才能找到这些的源代码?

4

11 回答 11

587

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.makeNamesTsstats:::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; 但不是.Internalor .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未压缩和未去皮文件的目录中找到。解压缩和去皮的步骤可以在外部RR使用untar()函数内部完成。可以将下载和扩展步骤合并到一个调用中(注意一次只能下载和解压一个包):

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

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

基础包中的编译代码

某些软件包被视为“基本”软件包。这些软件包随 R 一起提供,并且它们的版本被锁定为 R 的版本。示例包括basecompilerstatsutils. 因此,如上所述,它们不能作为 CRAN 上的单独可下载包提供。相反,它们是 R 源代码树的一部分,位于/src/library/. 下一节将介绍如何访问 R 源代码。

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

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

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

于 2013-10-07T13:58:00.650 回答
113

除了关于这个问题的其他答案及其重复项之外,这里有一个很好的方法来获取包函数的源代码,而无需知道它在哪个包中。例如,如果我们想要源代码randomForest::rfcv()

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

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

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

请注意,edit()打开一个文本编辑器(用户选择),同时 View()调用一个电子表格样式的数据查看器。

  • View()非常适合浏览(多列)数据,但对于玩具长度以外的任何代码通常都很糟糕。
  • 因此,当只想查看代码时,edit()IMO 实际上是否比 IMO 好得多View(),因为edit()您可以折叠/隐藏/虚拟出所有可能占用 R 函数 70% 的 arg-parsing/checking/default/error-message 逻辑, 并进入函数实际操作的部分(!),它的返回类型是什么类型的对象,它是否以及如何递归等等。

重定向到一个单独的文件(这样你就可以在你最喜欢的 IDE/编辑器中调出代码/使用 grep/etc 处理它):

capture.output(getAnywhere('rfcv'), file='source_rfcv.r')
于 2014-05-22T22:46:52.927 回答
30

当您使用 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() 即可完成相同的操作

于 2014-08-12T07:01:47.773 回答
29

对于非原始函数,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, where )。class(x) = "foo"列表成员之一(名为“fun”)是一个函数,我想print.foo()显示函数源代码,缩进。所以我最终得到了以下代码段print.foo()

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

缩进并显示与x[["fun"]].

编辑 2020-12-31

获得相同character源代码向量的一种不那么迂回的方法是:

sourceVector = deparse(body(x$fun))
于 2016-12-30T21:41:25.293 回答
22

没有看到这如何适合主要答案的流程,但它让我难过一段时间,所以我在这里添加它:

中缀运算符

要查看一些基本中缀运算符(例如,、、、)的源代码%%%*%%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("%%")

主要答案包括如何使用镜像进行更深入的挖掘。

于 2015-12-01T20:18:10.570 回答
14

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

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

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

于 2019-02-22T14:54:00.557 回答
12

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

new_optim <- edit(optim)

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

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

invisible(edit(optim))

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

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

于 2014-12-04T23:39:33.543 回答
9

只要该函数是用纯 R 而不是 C/C++/Fortran 编写的,就可以使用以下内容。否则最好的方法是调试并使用“跳转 ”:

> functionBody(functionName)
于 2017-01-24T16:42:33.640 回答
6

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

于 2017-01-11T02:45:22.197 回答
5

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

于 2017-12-26T11:45:54.630 回答
1

要查看函数的源代码,请使用 print()

f <- function(x){
     x * 2
 }

print(f)

function(x){
    x * 2
}
于 2021-08-10T07:48:03.080 回答