Formatting of column data

Kirill Müller, Hadley Wickham

2016-08-26

The presentation of a column in a tibble is powered by two S3 generics:

If you have written an S3 or S4 class that can be used as a column, you can override these generics to make sure your data prints well in a tibble. To start, you must import the tibble package. Either add tibble to the Imports: section of your DESCRIPTION, or simply call:

devtools::use_package("tibble")

This vignette assumes a package that implements an S3 class "foo" and uses roxygen2 to create documentation and the NAMESPACE file:

#' @export
foo <- function(x) {
  stopifnot(is.numeric(x))
  structure(x, class = "foo")
}

type_sum()

This method should return a length-1 character vector that can be used in a column header. Strive for an evocative abbreviation that’s under 6 characters.

type_sum(1)
#> [1] "dbl"
type_sum(1:10)
#> [1] "int"
type_sum(Sys.time())
#> [1] "dttm"

The default implementation works reasonably well for any kind of object, but the generated output may be too wide and waste precious space when displaying the tibble:

type_sum(foo(1:10))
#> [1] "S3: foo"

To avoid this for provide a method for type_sum():

#' @export
type_sum.foo <- function(x, ...) {
  "foo"
}

type_sum(foo(1:10))
#> [1] "foo"

obj_sum()

This method is primarily used for displaying list columns. A list column is a powerful way to attach hierarchical or unstructured data to an observation in a data frame. Implementations of obj_sum() are expected to return a character vector as long as the input, with brief description of the contents of each input element.

Examples:

obj_sum(1)
#> [1] "dbl [1]"
obj_sum(1:10)
#> [1] "int [10]"
obj_sum(Sys.time())
#> [1] "dttm [1]"
obj_sum(list(1:5))
#> [1] "int [5]"
obj_sum(list("a", "b", "c"))
#> [1] "chr [1]" "chr [1]" "chr [1]"

The default implementation calls type_sum() and appends the size of the object in brackets. If your object is built on top of an atomic vector the default will be adequate. You, will, however, need to provide a method if your object is vectorised and built on top of a list.

An example of an object of this type in base R POSIXlt: it is a list with 9 components.

x <- as.POSIXlt(Sys.time() + c(0, 60, 3600)) 
str(unclass(x))
#> List of 11
#>  $ sec   : num [1:3] 39.8 39.8 39.8
#>  $ min   : int [1:3] 42 43 42
#>  $ hour  : int [1:3] 13 13 14
#>  $ mday  : int [1:3] 26 26 26
#>  $ mon   : int [1:3] 7 7 7
#>  $ year  : int [1:3] 116 116 116
#>  $ wday  : int [1:3] 5 5 5
#>  $ yday  : int [1:3] 238 238 238
#>  $ isdst : int [1:3] 1 1 1
#>  $ zone  : chr [1:3] "CEST" "CEST" "CEST"
#>  $ gmtoff: int [1:3] 7200 7200 7200
#>  - attr(*, "tzone")= chr [1:3] "" "CET" "CEST"

But it pretends to be a vector with 3 elements:

x
#> [1] "2016-08-26 13:42:39 CEST" "2016-08-26 13:43:39 CEST"
#> [3] "2016-08-26 14:42:39 CEST"
length(x)
#> [1] 3
str(x)
#>  POSIXlt[1:3], format: "2016-08-26 13:42:39" "2016-08-26 13:43:39" ...

So we need to define a method that returns a character vector the same length as x:

#' @export
obj_sum.POSIXlt <- function(x) {
  rep("POSIXlt", length(x))
}