use a personnal print method inside print.tbl

Question

I have created a class called time. This is a dummy example which return seconds as minute. This works well, But the print.time function is not used inside a tbl.

Any ide how I can adapt the display inside a tbl ?

Regards

see reprex here

library(dplyr)
#> 
#> Attachement du package : 'dplyr'
#> The following objects are masked from 'package:stats':
#> 
#>     filter, lag
#> The following objects are masked from 'package:base':
#> 
#>     intersect, setdiff, setequal, union
as.time <- function(x){
  class(x)<-"time"
  x
}
print.time<-function(x,...){
  print.default(unclass(x/60)) 
  invisible(x)
}


60 %>% as.time() %>% print()
#> [1] 1


tribble(~a,~time,
        "a",123,
        "b",234,
        "c",456
) %>% mutate(time = as.time(time))
#> # A tibble: 3 x 2
#>   a      time
#>   <chr> <dbl>
#> 1 a       123
#> 2 b       234
#> 3 c       456

^{Created on 2019-02-07 by the reprex package (v0.2.1)}

Seems like you need to define more than just `print`. Maybe see https://cran.r-project.org/web/packages/tibble/vignettes/extending.html. — F. Privé, Feb 07 '19 at 12:19
I'm not familiar with "tibbles" but for correct printing of classes in data.frames you need a `format` method. — Roland, Feb 07 '19 at 12:26

Colin FAY · Accepted Answer · 2019-02-07T13:17:21.427

Quick and dirty hack

You can override the print.tbl method to do something custom and then call the tibble:::print.tbl function:

library(tidyverse)

as.time <- function(x){
  class(x)<-"time"
  x
}

is.time <- function(x) "time" %in% class(x)

res <- tribble(~a,~time,
               "a",123,
               "b",234,
               "c",456
) %>% mutate(time = as.time(time))

print.tbl <- function(x, ...){
  res <- mutate_if(x, is.time, ~ .x / 60)
  tibble:::print.tbl(res, ...)
}
res
#> # A tibble: 3 x 2
#>   a      time
#>   <chr> <dbl>
#> 1 a      2.05
#> 2 b      3.9 
#> 3 c      7.6

# Or if you want to make it ok for CRAN 

print.tbl <- function(x, ...){
  res <- mutate_if(x, is.time, ~ .x / 60)
  print_tbl <- getFromNamespace("print.tbl", "tibble")
  print_tbl(res, ...)
}
res
#> # A tibble: 3 x 2
#>   a      time
#>   <chr> <dbl>
#> 1 a      2.05
#> 2 b      3.9 
#> 3 c      7.6

^{Created on 2019-02-07 by the reprex package (v0.2.1)}

Edit: proper way to do it

You need to define several methods: print & format, pillar_shaft, and type_sum.

library(tibble)
library(pillar)
time <- function(x) {
  as_time(x)
}

as_time <- function(x) {
  structure(x, class = "time")
}

c.time <- function(x, ...) {
  as_time(NextMethod())
}

`[.time` <- function(x, i) {
  as_time(NextMethod())
}


format.time <- function(x, ...) {
  ret <- unclass(x / 60)
  format(ret)
}

print.time <- function(x, ...) {
  cat(format(x), sep = "\n")
  invisible(x)
}

time(360)
#> 6

type_sum.time <- function(x) {
  "time"
}

pillar_shaft.time <- function(x, ...) {
  out <- format(x)
  pillar::new_pillar_shaft_simple(out)
}


data <- tibble(
  loc   = time(360)
)

data
#> # A tibble: 1 x 1
#>   loc   
#>   <time>
#> 1 6

^{Created on 2019-02-07 by the reprex package (v0.2.1)}

See for more info: https://cran.r-project.org/web/packages/tibble/vignettes/extending.html

use a personnal print method inside print.tbl

1 Answers1

Quick and dirty hack

Edit: proper way to do it