Question

我一直致力于一项雄心勃勃的功能，我希望一旦完成，我就可以使用除我以外的其他人。当我只使用这个功能时，我可以忍受输出有点蹩脚，但如果我想要一些漂亮的输出怎么办？我正在寻找的基本上是这样的：

打印控制台可读内容的方法
能够访问打印的内容

更具体地说，假设我有三个我想要打印的标量对象：stat，dfree和pval。目前，我的方式是：

result <- list(statistic = stat, degrees = dfree, p.value = pval)
return(result)

这样我可以通过运行来访问这些值，例如（该函数被称为whites.htest）：

whites.htest$p.value

它有效，但输出有点难看。

> whites.htest(var.modell)
$statistic
[1] 36.47768

$degrees
[1] 30

$p.value
[1] 0.1928523

如果我们运行这样的简单VAR模型：

> library(vars)
> data <- matrix(rnorm(200), ncol = 2)
> VAR(data, p = 2, type = "trend")

VAR Estimation Results:
======================= 

Estimated coefficients for equation y1: 
======================================= 
Call:
y1 = y1.l1 + y2.l1 + y1.l2 + y2.l2 + trend 

       y1.l1        y2.l1        y1.l2        y2.l2        trend 
-0.090102007 -0.060138062  0.126250484  0.014423006  0.003138521 


Estimated coefficients for equation y2: 
======================================= 
Call:
y2 = y1.l1 + y2.l1 + y1.l2 + y2.l2 + trend 

       y1.l1        y2.l1        y1.l2        y2.l2        trend 
 0.040118527  0.018274399 -0.132943318 -0.031235939  0.003242241

输出看起来非常好。我已经看过它的底层代码（只需运行VAR），但我找不到让它看起来像这样的好东西。

所以我的问题是，如何在能够从函数中访问单个对象（即结果）的同时在控制台上打印出一些好的和可读的内容？

Answer 1

我能想到的一种方法是美化输入（如果你正在编写更多函数，则获得更多控制）是创建一个类并修改show方法。这样的事情：

# set your class name and its representation is list here.
setClass( "stat_test", representation("list"))


# show method (here's how the output would be printed
# you can format to whatever you want... to show and how to show
setMethod("show", "stat_test", function(object) {
    cat("object of", class(object), "\n")
    cat("Estimated Coefficients\n")
    cat("  statistics\t\t\tdegrees\t\t\tp.value\n")
    cat("  ", object$statistics, "\t\t\t", object$degrees, "\t\t\t", object$p.value,"\n")
})


# now your actual function (here dummy of course)
my_fun <- function(x) {
    t <- list(statistics=1.5, degrees=30, p.value=1e-2)
    new("stat_test", t)
}

# now calling
w <- my_fun(2)
> w # you get

object of stat_test 
Estimated Coefficients
  statistics            degrees         p.value
  1.5            30              0.01

你当然应该注意对齐。但这是一个基本的想法。

Answer 2

你应该给你的结果一个类，比如说“resclass”并创建一个print.resclass函数。 print是一个通用函数，它将搜索print.resclass的函数空间并将其应用于您的对象。您可以让print方法返回NULL或让它无形地返回对象值。通常的方法是重复调用cat。我看到阿伦已经提供了一个例子。总是可以从包装作者那里学习。这是你所崇拜的print.varest函数：

 vars:::print.varest
#---------------
function (x, digits = max(3, getOption("digits") - 3), ...) 
{
    dim <- length(x$varresult)
    names <- colnames(x$y)
    text1 <- "VAR Estimation Results:"
    cat(paste("\n", text1, "\n", sep = ""))
    row <- paste(rep("=", nchar(text1)), collapse = "")
    cat(row, "\n")
    cat("\n")
    for (i in 1:dim) {
        result <- coef(x$varresult[[i]])
        text1 <- paste("Estimated coefficients for equation ", 
            names[i], ":", sep = "")
        cat(text1, "\n")
        row <- paste(rep("=", nchar(text1)), collapse = "")
        cat(row, "\n")
        text2 <- paste("Call:\n", names[i], " = ", paste(names(result), 
            collapse = " + "), sep = "")
        cat(text2, "\n\n")
        print(result, ...)
        cat("\n\n")
    }
    invisible(x)
}
<environment: namespace:vars>

Answer 3

添加到@ DWin的答案..

# run your example code
library(vars)
data <- matrix(rnorm(200), ncol = 2)
# store the output of `x`
x <- VAR(data, p = 2, type = "trend")

# what kind of object is `x`?
class( x )

# look at code that the author of the `vars`
# package wrote for the print method
getS3method( 'print' , 'varest' )

# look at others..
getS3method( 'print' , 'varsum' )

# ..and others
methods( 'print' )

Answer 4

通常的做法是从函数中指定返回值以获得给定的类（您选择类的名称），然后为类创建一个打印方法，它将很好地格式化输出（通常使用{{ 1}}）并且无形地返回相同的对象。通常还有一个摘要方法和一个print.summary方法来提供额外的输出。

其他有助于提供简单但简单的输出的方法是将您想要的东西放在矩阵中并给出矩阵行名和列名，然后打印矩阵，print.matrix函数将采用把事情很好地排好。某些功能将使用cat和打印矩阵进行组合。

创造漂亮的输出

4 个答案: