r - 如何查看功能的源代码？

Question

我想看看函数的源代码，看看它是如何工作的。我知道我可以通过在提示符下键入函数名来打印函数：

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

在这种情况下， UseMethod("t")是什么意思？如何找到实际使用的源代码，例如： t(1:10)？
当我看到 UseMethod和当我看到 standardGeneric和 showMethods之间有什么区别吗？

> 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

如何找到 with和 .cbindts这样的函数？
在其他情况下，还有一些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")

如何找出 .makeNamesTs函数的作用？类似地，有些函数调用 .Primitive、 .C、 .Call、 .Fortran或 .External。我怎样才能找到这些的源代码？

Answer 1

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>

调用编译代码的函数
注意，“compiled”不是指由编译器包创建的字节编译的r代码。上面输出中的 <bytecode: 0x294e410>行表示函数是字节编译的，您仍然可以从r命令行查看源代码。
调用 .C、 .Call、 .Fortran、 .External、 .Internal或 .Primitive的函数正在调用编译代码中的入口点，因此如果要完全理解该函数，必须查看编译代码的源代码。 Thisr源代码的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])

或者，如果包开发是公开托管的（例如，通过 GitHub、 R-Forge或 RForge.net），则可以在线浏览源代码。
在基本包中编译的代码
某些包被认为是“基本”包。这些包随R一起提供，其版本锁定到R的版本。示例包括 base、 compiler、 stats和 utils。因此，它们不能作为单独的可下载软件包在Cran上提供，如上所述。相反，它们是 /src/library/下单个包目录中r源树的一部分。下一节将介绍如何访问r源。
R解释器中内置的编译代码
如果要查看r解释器内置的代码，则需要下载/解压缩r源代码；或者可以通过r Subversion repository或 Winston Chang's github mirror在线查看源代码。
uwe ligges的 R news article (PDF)（第43页）是如何查看 .Internal和 .Primitive函数的源代码的良好通用参考。基本步骤是首先在 src/main/names.c中查找函数名，然后在 src/main/*中的文件中搜索“c-entry”名称。