pkg/R/xtable.R

   1 ### xtable package
   2 ###
   3 ### Produce LaTeX and HTML tables from R objects.
   4 ###
   5 ### Copyright 2000-2013 David B. Dahl <dahl@stat.byu.edu>
   6 ###
   7 ### This file is part of the `xtable' library for R and related languages.
   8 ### It is made available under the terms of the GNU General Public
   9 ### License, version 2, or at your option, any later version,
  10 ### incorporated herein by reference.
  11 ###
  12 ### This program is distributed in the hope that it will be
  13 ### useful, but WITHOUT ANY WARRANTY; without even the implied
  14 ### warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15 ### PURPOSE.  See the GNU General Public License for more
  16 ### details.
  17 ###
  18 ### You should have received a copy of the GNU General Public
  19 ### License along with this program; if not, write to the Free
  20 ### Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  21 ### MA 02111-1307, USA
  22
  23 xtable <- function(x, caption = NULL, label = NULL, align = NULL,
  24                    digits = NULL, display = NULL, auto = FALSE, ...) {
  25   UseMethod("xtable")
  26 }
  27
  28
  29 ### data.frame and matrix objects
  30
  31 xtable.data.frame <- function(x, caption = NULL, label = NULL, align = NULL,
  32                               digits = NULL, display = NULL, auto = FALSE,
  33                               ...) {
  34   logicals <- unlist(lapply(x, is.logical))
  35   ##x[, logicals] <- lapply(x[, logicals], as.character)
  36   ## Patch for logicals bug, no 1911
  37   ## David Scott, <d.scott@auckland.ac.nz>, 2012-08-10
  38   x[, logicals] <- lapply(x[, logicals, drop = FALSE], as.character)
  39   characters <- unlist(lapply(x, is.character))
  40   factors <- unlist(lapply(x, is.factor))
  41   ints <- sapply(x, is.integer)
  42   class(x) <- c("xtable","data.frame")
  43   caption(x) <- caption
  44   label(x) <- label
  45   if(auto && is.null(align))   align   <- xalign(x)
  46   if(auto && is.null(digits))  digits  <- xdigits(x)
  47   if(auto && is.null(display)) display <- xdisplay(x)
  48   align(x) <- switch(1+is.null(align), align,
  49                      c("r",c("r","l")[(characters|factors)+1]))
  50   digits(x) <- switch(1+is.null(digits), digits, c(0,rep(2,ncol(x))))
  51   ## Patch from Seth Falcon <sfalcon@fhcrc.org>, 18-May-2007
  52   if (is.null(display)) {
  53       display <- rep("f", ncol(x))
  54       display[ints] <- "d"
  55       display[characters | factors] <- "s"
  56       display <- c("s", display)
  57   }
  58   display(x) <- display
  59   return(x)
  60 }
  61
  62 xtable.matrix <- function(x, caption = NULL, label = NULL, align = NULL,
  63                           digits = NULL, display = NULL, auto = FALSE, ...) {
  64   return(xtable.data.frame(data.frame(x, check.names = FALSE),
  65                            caption = caption, label = label, align = align,
  66                            digits = digits, display = display, auto = auto,
  67                            ...))
  68 }
  69
  70
  71
  72 ### table objects (of 1 or 2 dimensions) by Guido Gay, 9 Feb 2007
  73 ### Fixed to pass R checks by DBD, 9 May 2007
  74 xtable.table <- function(x, caption = NULL, label = NULL, align = NULL,
  75                        digits = NULL, display = NULL, auto = FALSE, ...) {
  76   if (length(dim(x)) == 1) {
  77     return(xtable.matrix(matrix(x,
  78                                 dimnames = list(rownames(x),
  79                                                 names(dimnames(x)))),
  80                          caption = caption, label = label, align = align,
  81                          digits = digits, display = display, auto = auto))
  82   } else if (length(dim(x))==2) {
  83     return(xtable.matrix(matrix(x, ncol = dim(x)[2], nrow = dim(x)[1],
  84                                 dimnames = list(rownames(x), colnames(x))),
  85                          caption = caption, label = label, align = align,
  86                          digits = digits, display = display, auto = auto))
  87   } else {
  88     stop("xtable.table is not implemented for tables of > 2 dimensions")
  89   }
  90 }
  91
  92
  93 ### anova objects
  94 xtable.anova <- function(x, caption = NULL, label = NULL, align = NULL,
  95                          digits = NULL, display = NULL, auto = FALSE, ...) {
  96   suggested.digits <- c(0,rep(2, ncol(x)))
  97   suggested.digits[grep("Pr\\(>", names(x))+1] <- 4
  98   suggested.digits[grep("P\\(>", names(x))+1] <- 4
  99   suggested.digits[grep("Df", names(x))+1] <- 0
 100
 101   class(x) <- c("xtable","data.frame")
 102   caption(x) <- caption
 103   label(x) <- label
 104   if(auto && is.null(align))   align   <- xalign(x)
 105   if(auto && is.null(digits))  digits  <- xdigits(x)
 106   if(auto && is.null(display)) display <- xdisplay(x)
 107   align(x) <- switch(1+is.null(align), align, c("l",rep("r", ncol(x))))
 108   digits(x) <- switch(1+is.null(digits), digits, suggested.digits)
 109   display(x) <- switch(1+is.null(display), display, c("s",rep("f", ncol(x))))
 110   return(x)
 111 }
 112
 113
 114 ### aov objects
 115 xtable.aov <- function(x, caption = NULL, label = NULL, align = NULL,
 116                        digits = NULL, display = NULL, auto = FALSE, ...) {
 117   return(xtable.anova(anova(x, ...), caption = caption, label = label,
 118                       align = align, digits = digits, display = display,
 119                       auto = auto))
 120 }
 121
 122 xtable.summary.aov <- function(x, caption = NULL, label = NULL, align = NULL,
 123                                digits = NULL, display = NULL, auto = FALSE,
 124                                ...) {
 125   return(xtable.anova(x[[1]], caption = caption, label = label, align = align,
 126                       digits = digits, display = display, auto = auto))
 127 }
 128
 129 xtable.summary.aovlist <- function(x, caption = NULL, label = NULL,
 130                                    align = NULL, digits = NULL, display = NULL,
 131                                    auto = FALSE, ...) {
 132     for (i in 1:length(x)) {
 133         if (i == 1) {
 134             result <- xtable.summary.aov(x[[i]], caption = caption,
 135                                          label = label,
 136                                          align = align, digits = digits,
 137                                          display = display, auto = auto)
 138         } else {
 139             result <- rbind(result,
 140                             xtable.anova(x[[i]][[1]], caption = caption,
 141                                          label = label, align = align,
 142                                          digits = digits, display = display,
 143                                          auto = auto))
 144         }
 145     }
 146     return(result)
 147 }
 148
 149 xtable.aovlist <- function(x, caption = NULL, label = NULL, align = NULL,
 150                            digits = NULL, display = NULL, auto = FALSE, ...) {
 151   return(xtable.summary.aovlist(summary(x), caption = caption, label = label,
 152                                 align = align, digits = digits,
 153                                 display = display, auto = auto))
 154 }
 155
 156
 157
 158 ### lm objects
 159 xtable.lm <- function(x, caption = NULL, label = NULL, align = NULL,
 160                       digits = NULL, display = NULL, auto = FALSE, ...) {
 161   return(xtable.summary.lm(summary(x), caption = caption, label = label,
 162                            align = align, digits = digits, display = display,
 163                            auto = auto))
 164 }
 165
 166 xtable.summary.lm <- function(x, caption = NULL, label = NULL, align = NULL,
 167                               digits = NULL, display = NULL, auto = FALSE,
 168                               ...) {
 169   x <- data.frame(x$coef, check.names = FALSE)
 170
 171   class(x) <- c("xtable","data.frame")
 172   caption(x) <- caption
 173   label(x) <- label
 174   if(auto && is.null(align))   align   <- xalign(x)
 175   if(auto && is.null(digits))  digits  <- xdigits(x)
 176   if(auto && is.null(display)) display <- xdisplay(x)
 177   align(x) <- switch(1+is.null(align), align, c("r","r","r","r","r"))
 178   digits(x) <- switch(1+is.null(digits), digits, c(0,4,4,2,4))
 179   display(x) <- switch(1+is.null(display), display, c("s","f","f","f","f"))
 180   return(x)
 181 }
 182
 183
 184 ### glm objects
 185 xtable.glm <- function(x, caption = NULL, label = NULL, align = NULL,
 186                        digits = NULL, display = NULL, auto = FALSE, ...) {
 187   return(xtable.summary.glm(summary(x), caption = caption,
 188                             label = label, align = align,
 189                             digits = digits, display = display, auto = auto))
 190 }
 191
 192 xtable.summary.glm <- function(x, caption = NULL, label = NULL, align = NULL,
 193                                digits = NULL, display = NULL, auto = FALSE,
 194                                ...) {
 195   return(xtable.summary.lm(x, caption = caption, label = label, align = align,
 196                            digits = digits, display = display, auto = auto))
 197 }
 198
 199
 200 ### prcomp objects
 201 xtable.prcomp <- function(x, caption = NULL, label = NULL, align = NULL,
 202                           digits = NULL, display = NULL, auto = FALSE, ...) {
 203   x <- data.frame(x$rotation, check.names = FALSE)
 204
 205   class(x) <- c("xtable","data.frame")
 206   caption(x) <- caption
 207   label(x) <- label
 208   if(auto && is.null(align))   align   <- xalign(x)
 209   if(auto && is.null(digits))  digits  <- xdigits(x)
 210   if(auto && is.null(display)) display <- xdisplay(x)
 211   align(x) <- switch(1+is.null(align), align, c("r",rep("r", ncol(x))))
 212   digits(x) <- switch(1+is.null(digits), digits, c(0,rep(4, ncol(x))))
 213   display(x) <- switch(1+is.null(display), display, c("s",rep("f", ncol(x))))
 214   return(x)
 215 }
 216
 217 xtable.summary.prcomp <- function(x, caption = NULL, label = NULL, align = NULL,
 218                                   digits = NULL, display = NULL, auto = FALSE,
 219                                   ...) {
 220   x <- data.frame(x$importance, check.names = FALSE)
 221
 222   class(x) <- c("xtable","data.frame")
 223   caption(x) <- caption
 224   label(x) <- label
 225   if(auto && is.null(align))   align   <- xalign(x)
 226   if(auto && is.null(digits))  digits  <- xdigits(x)
 227   if(auto && is.null(display)) display <- xdisplay(x)
 228   align(x) <- switch(1+is.null(align), align, c("r",rep("r", ncol(x))))
 229   digits(x) <- switch(1+is.null(digits), digits, c(0,rep(4, ncol(x))))
 230   display(x) <- switch(1+is.null(display), display, c("s",rep("f", ncol(x))))
 231   return(x)
 232 }
 233
 234
 235 ### Slightly modified version of xtable.coxph contributed on r-help by
 236 ###   Date: Wed, 2 Oct 2002 17:47:56 -0500 (CDT)
 237 ###   From: Jun Yan <jyan@stat.wisc.edu>
 238 ###   Subject: Re: [R] xtable for Cox model output
 239 xtable.coxph <- function (x, caption = NULL, label = NULL, align = NULL,
 240                           digits = NULL, display = NULL, auto = FALSE, ...)
 241 {
 242   cox <- x
 243   beta <- cox$coef
 244   se <- sqrt(diag(cox$var))
 245   if (is.null(cox$naive.var)) {
 246     tmp <- cbind(beta, exp(beta), se, beta/se, 1 - pchisq((beta/se)^2, 1))
 247     dimnames(tmp) <- list(names(beta),
 248       c("coef", "exp(coef)", "se(coef)", "z", "p"))
 249   } else {
 250     tmp <- cbind( beta, exp(beta), se, beta/se,
 251       signif(1 - pchisq((beta/se)^2, 1), digits - 1))
 252     dimnames(tmp) <- list(names(beta),
 253       c("coef", "exp(coef)", "robust se", "z", "p"))
 254   }
 255   return(xtable(tmp, caption = caption, label = label, align = align,
 256                 digits = digits, display = display, auto = auto))
 257 }
 258
 259 ### Additional method: xtable.ts
 260 ### Contributed by David Mitchell (davidm@netspeed.com.au)
 261 ### Date: July 2003
 262 xtable.ts <- function(x, caption = NULL, label = NULL, align = NULL,
 263                       digits = NULL, display = NULL, auto = FALSE, ...) {
 264   if (inherits(x, "ts") && !is.null(ncol(x))) {
 265     ## COLNAMES <- paste(colnames(x));
 266     tp.1 <- trunc(time(x))
 267     tp.2 <- trunc(cycle(x))
 268     day.abb <- c("Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat")
 269     ROWNAMES <- switch(frequency(x),
 270                        tp.1,
 271                        "Arg2", "Arg3",              # Dummy arguments
 272                        paste(tp.1, c("Q1", "Q2", "Q3", "Q4")[tp.2], sep = " "),
 273                        "Arg5", "Arg6",
 274                        paste("Wk.", tp.1, " ", day.abb[tp.2], sep = ""),
 275                        "Arg8", "Arg9", "Arg10", "Arg11",
 276                        paste(tp.1, month.abb[tp.2], sep = " "))
 277     tmp <- data.frame(x, row.names = ROWNAMES);
 278   } else if (inherits(x, "ts") && is.null(ncol(x))) {
 279     COLNAMES <- switch(frequency(x),
 280                        "Value",
 281                        "Arg2", "Arg3",              # Dummy arguments
 282                        c("Q1", "Q2", "Q3", "Q4"),
 283                        "Arg5", "Arg6",
 284                        day.abb,
 285                        "Arg8", "Arg9", "Arg10", "Arg11",
 286                        month.abb)
 287     ROWNAMES <- seq(from = start(x)[1], to = end(x)[1])
 288     tmp <- data.frame(matrix(c(rep(NA, start(x)[2] - 1), x,
 289                                rep(NA, frequency(x) - end(x)[2])),
 290                              ncol = frequency(x), byrow = TRUE),
 291                       row.names = ROWNAMES)
 292     names(tmp) <- COLNAMES
 293   }
 294   return(xtable(tmp, caption = caption, label = label, align = align,
 295                 digits = digits, display = display, auto = auto))
 296 }
 297
 298 ### Suggested by Ajay Narottam Shah <ajayshah@mayin.org> in e-mail 2006/07/22
 299 xtable.zoo <- function(x, ...) {
 300   return(xtable(as.ts(x), ...))
 301 }
 302
 303 ### Date: Fri, 29 May 2015 11:41:04 +0200
 304 ### From: Martin G. <martin.gubri@framasoft.org>
 305 ### Subject: [xtable] Code for spdep, splm and sphet objects outputs
 306 ### package spdep
 307 ### sarlm objects
 308 xtable.sarlm <- function(x, caption = NULL, label = NULL, align = NULL,
 309                          digits = NULL, display = NULL, auto = FALSE, ...) {
 310   return(xtable.summary.sarlm(summary(x), caption = caption, label = label,
 311                               align = align, digits = digits,
 312                               display = display, auto = auto))
 313 }
 314
 315 xtable.summary.sarlm <- function(x, caption = NULL, label = NULL, align = NULL,
 316                                 digits = NULL, display = NULL, auto = FALSE,
 317                                 ...) {
 318   x <- data.frame(x$Coef, check.names = FALSE)
 319
 320   class(x) <- c("xtable","data.frame")
 321   caption(x) <- caption
 322   label(x) <- label
 323   if(auto && is.null(align))   align   <- xalign(x)
 324   if(auto && is.null(digits))  digits  <- xdigits(x)
 325   if(auto && is.null(display)) display <- xdisplay(x)
 326   align(x) <- switch(1+is.null(align), align, c("r","r","r","r","r"))
 327   digits(x) <- switch(1+is.null(digits), digits, c(0,4,4,2,4))
 328   display(x) <- switch(1+is.null(display), display, c("s","f","f","f","f"))
 329   return(x)
 330 }
 331
 332 ### spautolm objects: added by David Scott, 6/1/2016, after suggestion by
 333 ### Guido Schulz
 334 ### Date: Wed, 29 Apr 2015 10:45:16 +0200
 335 ### Guido Schulz <schulzgu@student.hu-berlin.de>
 336 xtable.spautolm <- function(x, caption = NULL, label = NULL, align = NULL,
 337                             digits = NULL, display = NULL, auto = FALSE, ...) {
 338     return(xtable.summary.sarlm(summary(x), caption = caption, label = label,
 339                               align = align, digits = digits,
 340                               display = display, auto = auto))
 341 }
 342
 343 xtable.summary.spautolm <- function(x, caption = NULL, label = NULL,
 344                                     align = NULL, digits = NULL,
 345                                     display = NULL, auto = FALSE, ...) {
 346     return(xtable.summary.sarlm(summary(x), caption = caption, label = label,
 347                               align = align, digits = digits,
 348                               display = display, auto = auto))
 349 }
 350
 351
 352 ### gmsar objects
 353 xtable.gmsar <- function(x, caption = NULL, label = NULL, align = NULL,
 354                          digits = NULL, display = NULL, auto = FALSE, ...) {
 355     return(xtable.summary.sarlm(summary(x), caption = caption, label = label,
 356                               align = align, digits = digits,
 357                               display = display, auto = auto, ...))
 358 }
 359
 360 xtable.summary.gmsar <- function(x, caption = NULL, label = NULL, align = NULL,
 361                                  digits = NULL, display = NULL,
 362                                  auto = FALSE, ...) {
 363   return(xtable.summary.sarlm(x, caption = caption, label = label,
 364                               align = align, digits = digits,
 365                               display = display, auto = auto))
 366 }
 367
 368 ### stsls objects
 369 xtable.stsls <- function(x, caption = NULL, label = NULL, align = NULL,
 370                          digits = NULL, display = NULL, auto = FALSE, ...) {
 371   return(xtable.summary.sarlm(summary(x), caption = caption, label = label,
 372                               align = align, digits = digits,
 373                               display = display, auto = auto, ...))
 374 }
 375
 376 xtable.summary.stsls <- function(x, caption = NULL, label = NULL, align = NULL,
 377                                  digits = NULL, display = NULL,
 378                                  auto = FALSE, ...) {
 379   return(xtable.summary.sarlm(x, caption = caption, label = label,
 380                               align = align, digits = digits,
 381                               display = display, auto = auto))
 382 }
 383
 384 ### pred.sarlm objects
 385 xtable.sarlm.pred <- function(x, ...) {
 386   return(xtable(as.data.frame(x), ...))
 387 }
 388
 389 ### lagImpact objects
 390 xtable.lagImpact <- function(x, ...) {
 391   xtable(spdep:::lagImpactMat(x), ...)
 392 }
 393
 394 ### package splm
 395 ### splm objects
 396 xtable.splm <- function(x, caption = NULL, label = NULL, align = NULL,
 397                         digits = NULL, display = NULL, auto = FALSE, ...) {
 398   return(xtable.summary.splm(summary(x), caption = caption, label = label,
 399                              align = align, digits = digits,
 400                              display = display, auto = auto))
 401 }
 402
 403 xtable.summary.splm <- function(x, caption = NULL, label = NULL, align = NULL,
 404                                 digits = NULL, display = NULL, auto = FALSE,
 405                                 ...) {
 406   x <- data.frame(x$CoefTable, check.names = FALSE)
 407
 408   class(x) <- c("xtable","data.frame")
 409   caption(x) <- caption
 410   label(x) <- label
 411   if(auto && is.null(align))   align   <- xalign(x)
 412   if(auto && is.null(digits))  digits  <- xdigits(x)
 413   if(auto && is.null(display)) display <- xdisplay(x)
 414   align(x) <- switch(1+is.null(align), align, c("r","r","r","r","r"))
 415   digits(x) <- switch(1+is.null(digits), digits, c(0,4,4,2,4))
 416   display(x) <- switch(1+is.null(display), display, c("s","f","f","f","f"))
 417   return(x)
 418 }
 419
 420 ### package sphet
 421 ### sphet objects
 422 xtable.sphet <- function(x, caption = NULL, label = NULL, align = NULL,
 423                          digits = NULL, display = NULL, auto = FALSE, ...) {
 424   return(xtable.summary.splm(summary(x), caption = caption, label = label,
 425                              align = align, digits = digits,
 426                              display = display, auto = auto))
 427 }
 428
 429 xtable.summary.sphet <- function(x, caption = NULL, label = NULL, align = NULL,
 430                                  digits = NULL, display = NULL,
 431                                  auto = FALSE, ...) {
 432   return(xtable.summary.splm(x, caption = caption, label = label,
 433                              align = align, digits = digits,
 434                              display = display, auto = auto))
 435 }