S4: a short guide for the perplexed

Principle 1: it’s all about the abstraction

S4 objects don't do anything; they are pure data. Accepting that is the first step towards mastery of OOP in #rstats.

— Michael Lawrence (@lawremi) August 14, 2015

The design of an S4 class is merely a way of setting up an abstraction for a data analysis problem. This is often the hardest part of using S4, coming up with a ‘good-enough’ abstraction for the problem at hand.

Let’s try creating an S4 class for a Turtle. A turtle can move in a path in two dimensions as illustrated below:

We can define a class to represent a Turtle as follows:

library(methods)
setClass("Turtle", 
         slots = c(location = "numeric", orientation = "numeric", path = "matrix")
)

At a minimum an S4 class needs two things the name of the class and a named character vector of slots. Slots define the data that forms the class. In the case of the Turtle, we have three slots one representing the turtle’s current location as a numeric vector, one representing it’s current orientation (the angle that the turtle is facing), and finally a matrix representing the path it’s travelled so far.

We can create an instance of a Turtle using new:

lil_turtle <- new("Turtle", 
                  location = c(0,0), 
                  orientation = 0,
                  path = matrix(c(0,0), ncol = 2))
lil_turtle

## An object of class "Turtle"
## Slot "location":
## [1] 0 0
## 
## Slot "orientation":
## [1] 0
## 
## Slot "path":
##      [,1] [,2]
## [1,]    0    0

Slots can be accessed using @ but we will see later it’s better to define functions called getters that access each component of the object.

lil_turtle@location

## [1] 0 0

lil_turtle@orientation

## [1] 0

We would like to ensure that when we create a new turtle that it’s current location is always a numeric vector of length 2, and that it’s orientation is in degrees between -360 to 360. We’ll also check that the path is a matrix with two columns. We can do this by creating a function to check our turtle is valid:

okTurtle <- function(object) {
  # check location has length 2
  loc_ln <- length(object@location)
  # check orientation is between -360 to 360 and has length one
  orientation <- object@orientation
  # check path is a numeric matrix
  path <- object@path
  c(if (loc_ln != 2) "location must have length two.",
    if (length(orientation) != 1) "orientation must have length one.",
    if (abs(orientation) > 360) paste("orientation angle", orientation, "must be between -360 and 360 degrees."),
    if (mode(path) != "numeric") "path must be a numeric matrix",
    if (ncol(path) != 2) "path must have two columns"
  )
  TRUE
}

setValidity("Turtle", okTurtle)

## Class "Turtle" [in ".GlobalEnv"]
## 
## Slots:
##                                           
## Name:     location orientation        path
## Class:     numeric     numeric      matrix

This updates the class definition, to include the checking a turtle is an OK turtle.

Finally, we need an interface to creating a objects of class Turtle. This is called a constructor. Generally, this is a function that calls new and has arguments corresponding to the slots of our object.

Turtle <- function(location = c(0,0), orientation = 0) {
  new("Turtle", 
      location = location, 
      orientation = orientation,
      path = matrix(location, ncol = 2))
}

Calling new now that the validity is set, will check that the arguments provided to the constructor result in a proper turtle. We haven’t included an argument for the path, cause our Turtle hasn’t travelled anywhere yet…

Note that it’s a convention when using S4 to use CamelCase (I don’t make the rules!).

So far we can’t do anything interesting with turtles, we need to define some methods!

Principle 2: in statistics we like functions

Both S3 and S4 use generic functions which is a little different from other object-oriented programming languages (it is a variety of ad-hoc polymorphism if you like that kind of thing). A generic function determines how a method is called when an argument is a given class (or combination of classes). In general, a generic function should be created if you plan to reuse it for many distinct classes or if it will be useful to other package developers.

For example, we could create two generic functions that represent a turtle moving forward and a turtle turning.

setGeneric("forward", 
           function(x, ...) standardGeneric("forward")
)

## [1] "forward"

This creates a function called forward with an argument x, called the signature of the generic and ... which can be other arguments that will determine how a turtle moves. The class of x changes which forward method will be selected.

Similarly, we can implement a generic for reorienting a turtle.

setGeneric("turn", function(x, ...) standardGeneric("turn"))

## [1] "turn"

To complete our interface, we will also create generics for accessing and replacing each slot of our class.

setGeneric("location", function(x) standardGeneric("location"))

## [1] "location"

setGeneric("location<-", function(x, value) standardGeneric("location<-"))

## [1] "location<-"

setGeneric("orientation", function(x) standardGeneric("orientation"))

## [1] "orientation"

setGeneric("orientation<-", function(x, value) standardGeneric("orientation<-"))

## [1] "orientation<-"

setGeneric("path", function(x) standardGeneric("path"))

## [1] "path"

setGeneric("path<-", function(x, value) standardGeneric("path<-"))

## [1] "path<-"

We now have a bunch of generics next we need to create methods for our turtle. Let’s start simple with our getter functions. To create a method, we use setMethod with : * the name of our generic * an argument called ‘signature’, that tells us the class the generic will dispatch on * a function that tells us what the method does

setMethod("location", signature = "Turtle", function(x) x@location)
setMethod("orientation", signature = "Turtle", function(x) x@orientation)
setMethod("path", signature = "Turtle", function(x) x@path )

We can also create our replacement methods, these will update each slot. A turtle’s orientation and path are always updated relative to where they already are positioned.

setMethod("location<-", signature = "Turtle", function(x, value) {
  x@location <- value
  stopifnot(validObject(x))
  x
})

setMethod("orientation<-", signature = "Turtle", function(x, value) {
  x@orientation <- orientation(x) + value
  stopifnot(validObject(x))
  x
})

setMethod("path<-", "Turtle", function(x, value) {
  x@path <- rbind(path(x), matrix(value, ncol = 2))
  stopifnot(validObject(x))
  x
})

Now we can implement methods for forward and turn:

setMethod("forward", signature = "Turtle",
          function(x, steps) {
            location <- location(x)
            angle <- orientation(x) * pi / 180
            x_dir <- steps * cos(angle)
            y_dir <- steps * sin(angle)
            
            new_location <- c(location[1] + x_dir, 
                              location[2] + y_dir)
            
            location(x) <- new_location
            path(x) <- new_location
            
            x
          })

setMethod("turn", "Turtle", function(x, angle) {
  orientation(x) <- angle
  x
})

Most of the time, you probably don’t need a new generic function but rather to reuse an existing one (for Bioconductor packages generic functions are contained in the BiocGenerics package) by setting a method for your class. For example, maybe we want a prettier printing method for our turtle, for S4 classes, the print method is called “show”:

setMethod("show", "Turtle",
          function(object) {
            utf8::utf8_print(paste("\U1F422",
                                   paste("Located at:", paste(round(location(object), 1), collapse = ",")),
                                   paste("Facing:", orientation(object), "degrees"),
                                   collapse = "\n"))
          })

lil_turtle

## [1] "🐢​ Located at: 0,0 Facing: 0 degrees"

When designing a new class it’s a good idea to target methods for generic functions that are in the base API. This ensures portability of your code and means that your class behaves in a way that is already familiar to a user.

Now we have implemented enough methods to make our turtle move, we can start getting our turtle to move around in 2-d! For example, we could move in a triangle:

library(magrittr)
turtle <- Turtle()

turtle <- turtle %>% 
  turn(angle = 60) %>% 
  forward(steps = 3) %>%
  turn(angle = -120) %>% 
  forward(steps = 3) %>% 
  turn(angle = -120) %>% 
  forward(steps = 3)

turtle 

## [1] "🐢​ Located at: 0,0 Facing: -180 degrees"

path_taken <- path(turtle)
plot(path_taken)
segments(path_taken[1:3,1], 
         path_taken[1:3,2], 
         path_taken[2:4, 1], 
         path_taken[2:4, 2])

Principle 3: designing is hard, reuse instead!

If you're going to have a big multi-site collaboration, the language you're going to use isn't what you need to agree on. They key is stadardizing data structures. - Robert Gentleman #Bioc2019 #RGentlemanSymposium

— Gabe Becker (@groundwalkergmb) June 27, 2019

In R there is usually package for the task you would like to perform. Similarly, when using S4 somebody has probably done the hard work of designing a class related to an analysis or problem at hand. In Bioconductor, the community has standardised core data structures related to all aspects of ‘omics’, with two key examples being the SummarizedExperiment and Ranges classes. Instead of inventing your own class you can extend (or just use) other package’s data structures. If the class has been implemented well, you won’t have to go through the boring process of implementing an interface such as making setters and getters.

Let’s extend our Turtle class, to a Turtle that’s holding a pen. A turtle holding a pen will include three new slots: colour, thickness, and an on/off switch.

setClass("TurtleWithPen", 
         slots = c(colour = "character", thickness = "numeric", on = "logical"),
         contains = "Turtle")

The argument contains = "Turtle" tells setClass we are inheriting from the Turtle class. A TurtleWithPen is still a Turtle but has additional slots corresponding to a Pen. We can write a constructor for a Turtle holding a pen:

TurtleWithPen <- function(x, colour = "pink", thickness = 1, on = FALSE) {
  new("TurtleWithPen", colour = colour, thickness = thickness, on = on, x)
}

turtle <- TurtleWithPen(Turtle())
turtle

## [1] "🐢​ Located at: 0,0 Facing: 0 degrees"

class(turtle)

## [1] "TurtleWithPen"
## attr(,"package")
## [1] ".GlobalEnv"

Our TurtleWithPen inherits all the methods associated with Turtle, including show which is why the displayed object looks the same. All the same moves we made with an ordinary turtle can be made by one holding a pen:

turtle %>% 
  turn(angle = 60) %>% 
  forward(steps = 3) %>%
  turn(angle = -120) %>% 
  forward(steps = 3) %>% 
  turn(angle = -120) %>% 
  forward(steps = 3)

## [1] "🐢​ Located at: 0,0 Facing: -180 degrees"

Now we want to modify the show method, if the pen is on, then will animate the Turtle’s path, otherwise we will show the Turtle has normal.

setMethod("show", "TurtleWithPen", 
          function(object) {
            if (object@on) {
              path <- path(object)
              colnames(path) <- c("x", "y")
              path_tbl <- data.frame(path, id = seq_len(nrow(path)))
              plot <- ggplot2::ggplot(data = path_tbl) + 
                ggplot2::geom_path(ggplot2::aes(x, y), 
                                   colour = object@colour, 
                                   size = object@thickness) +
                ggplot2::theme_void() + 
                gganimate::transition_reveal(id)
              gganimate::animate(plot)
            } else {
              callNextMethod()
            }
          })

Now the show method will animate, if the pen is switched on, otherwise we will call the regular Turtle method.

We can try this out by having our Turtle walk through an equilateral triangle:

pendown <- function(x) {
  x@on <- TRUE
  x
}
penup <- function(x) {
  x@on <- FALSE
  x
}

turtle <- turtle %>% 
  pendown() %>% 
  turn(angle = 60) %>% 
  forward(steps = 3) %>%
  turn(angle = -120) %>% 
  forward(steps = 3) %>% 
  turn(angle = -120) %>% 
  forward(steps = 3)


turtle %>% 
  show()

But if we put the pen up, then we get the usual show method:

turtle %>% 
  penup() 

## [1] "🐢​ Located at: 0,0 Facing: -180 degrees"

## 🐢 Located at: 0,0 Facing: -180 degrees

Where to find out more?

This post has barely scratched the surface of what S4 can do. We haven’t really touched on the ideas of multiple inheritance or multiple dispatch. Hopefully though if you’re new to S4, the ideas behind it are a little less scary!

There are several resources for learning more about S4:

• These course notes by Martin Morgan and Hervè Pagès go into detail about what you need to use S4 in a package.

• Hadley Wickham’s Advanced R book has a section on S4 (and here) and other types of object-oriented programming in R.

• If you want to get into the nitty-gritty technicalities of S4 programming, take a look at John Chamber’s Software for Data Analysis.

• Looking in the wild. Two examples of non-Bioconductor packages that make use of S4 are the Matrix and rstan.