# Introduction to data.table

require(data.table) knitr::opts_chunk$set( comment = "#", error = FALSE, tidy = FALSE, cache = FALSE, collapse = TRUE) This vignette introduces the data.table syntax, its general form, how to subset rows, select and compute on columns and perform aggregations by group. Familiarity with data.frame data structure from base R is useful, but not essential to follow this vignette. ## Data analysis using data.table Data manipulation operations such as subset, group, update, join etc., are all inherently related. Keeping these related operations together allows for: • concise and consistent syntax irrespective of the set of operations you would like to perform to achieve your end goal. • performing analysis fluidly without the cognitive burden of having to map each operation to a particular function from a set of functions available before to perform the analysis. • automatically optimising operations internally, and very effectively, by knowing precisely the data required for each operation and therefore very fast and memory efficient. Briefly, if you are interested in reducing programming and compute time tremendously, then this package is for you. The philosophy that data.table adheres to makes this possible. Our goal is to illustrate it through this series of vignettes. ## Data {#data} In this vignette, we will use NYC-flights14 data. It contains On-Time flights data from the Bureau of Transporation Statistics for all the flights that departed from New York City airports in 2014 (inspired by nycflights13). The data is available only for Jan-Oct'14. We can use data.table's fast file reader fread to load flights directly as follows: options(width = 100L) flights <- fread("flights14.csv") flights dim(flights) Aside: fread accepts http and https URLs directly as well as operating system commands such as sed and awk output. See ?fread for examples. ## Introduction In this vignette, we will 1. start with basics - what is a data.table, its general form, how to subset rows, select and compute on columns 2. and then we will look at performing data aggregations by group, ## 1. Basics {#basics-1} ### a) What is data.table? {#what-is-datatable-1a} data.table is an R package that provides an enhanced version of data.frames. In the Data section, we already created a data.table using fread(). We can also create one using the data.table() function. Here is an example: DT = data.table(ID = c("b","b","b","a","a","c"), a = 1:6, b = 7:12, c = 13:18) DT class(DT$ID)

You can also convert existing objects to a data.table using as.data.table().

#### Note that: {.bs-callout .bs-callout-info}

• Unlike data.frames, columns of character type are never converted to factors by default.

• Row numbers are printed with a : in order to visually separate the row number from the first column.

• When the number of rows to print exceeds the global option datatable.print.nrows (default = r getOption("datatable.print.nrows")), it automatically prints only the top 5 and bottom 5 rows (as can be seen in the Data section).

  getOption("datatable.print.nrows")

• data.table doesn't set or use row names, ever. We will see as to why in "Keys and fast binary search based subset" vignette.

### b) General form - in what way is a data.table enhanced? {#enhanced-1b}

In contrast to a data.frame, you can do a lot more than just subsetting rows and selecting columns within the frame of a data.table, i.e., within [ ... ]. To understand it we will have to first look at the general form of data.table syntax, as shown below:

DT[i, j, by] ## R: i j by ## SQL: where select | update group by

Users who have a SQL background might perhaps immediately relate to this syntax.

#### The way to read it (out loud) is: {.bs-callout .bs-callout-info}

Take DT, subset rows using i, then calculate j, grouped by by.

#

Let's begin by looking at i and j first - subsetting rows and operating on columns.

### c) Subset rows in i {#subset-i-1c}

#### -- Get all the flights with "JFK" as the origin airport in the month of June.

ans <- flights[origin == "JFK" & month == 6L] head(ans)

#### {.bs-callout .bs-callout-info #with_false}

• Using with() in (2) allows using DF's column x as if it were a variable.

Hence the argument name with in data.table. Setting with = FALSE disables the ability to refer to columns as if they are variables, thereby restoring the "data.frame mode".

• We can also deselect columns using - or !. For example:

 ## not run # returns all columns except arr_delay and dep_delay ans <- flights[, !c("arr_delay", "dep_delay"), with = FALSE] # or ans <- flights[, -c("arr_delay", "dep_delay"), with = FALSE]
• From v1.9.5+, we can also select by specifying start and end column names, for e.g, year:day to select the first three columns.

 ## not run # returns year,month and day ans <- flights[, year:day, with = FALSE] # returns day, month and year ans <- flights[, day:year, with = FALSE] # returns all columns except year, month and day ans <- flights[, -(year:day), with = FALSE] ans <- flights[, !(year:day), with = FALSE]

This is particularly handy while working interactively.

#

with = TRUE is default in data.table because we can do much more by allowing j to handle expressions - especially when combined with by as we'll see in a moment.

## 2. Aggregations

We've already seen i and j from data.table's general form in the previous section. In this section, we'll see how they can be combined together with by to perform operations by group. Let's look at some examples.

### a) Grouping using by

#### -- How can we get the number of trips corresponding to each origin airport?

ans <- flights[, .(.N), by = .(origin)] ans ## or equivalently using a character vector in 'by' # ans <- flights[, .(.N), by = "origin"]

#### {.bs-callout .bs-callout-info}

• We know .N is a special variable that holds the number of rows in the current group. Grouping by origin obtains the number of rows, .N, for each group.

• By doing head(flights) you can see that the origin airports occur in the order "JFK", "LGA" and "EWR". The original order of grouping variables is preserved in the result.

• Since we did not provide a name for the column returned in j, it was named Nautomatically by recognising the special symbol .N.

• by also accepts character vector of column names. It is particularly useful to program with, for e.g., designing a function with the columns to be group by as a function argument.

• When there's only one column or expression to refer to in j and by, we can drop the .() notation. This is purely for convenience. We could instead do:

 ans <- flights[, .N, by = origin] ans

We'll use this convenient form wherever applicable hereafter.

#

#### -- How can we calculate the number of trips for each origin airport for carrier code "AA"? {#origin-.N}

The unique carrier code "AA" corresponds to American Airlines Inc.

ans <- flights[carrier == "AA", .N, by = origin] ans

#### {.bs-callout .bs-callout-info}

• We first obtain the row indices for the expression carrier == "AA" from i.

• Using those row indices, we obtain the number of rows while grouped by origin. Once again no columns are actually materialised here, because the j-expression does not require any columns to be actually subsetted and is therefore fast and memory efficient.

#### -- How can we get the total number of trips for each origin, dest pair for carrier code "AA"? {#origin-dest-.N}

ans <- flights[carrier == "AA", .N, by = .(origin,dest)] head(ans) ## or equivalently using a character vector in 'by' # ans <- flights[carrier == "AA", .N, by = c("origin", "dest")]

#### {.bs-callout .bs-callout-info}

• by accepts multiple columns. We just provide all the columns by which to group by.

#### -- How can we get the average arrival and departure delay for each orig,dest pair for each month for carrier code "AA"? {#origin-dest-month}

ans <- flights[carrier == "AA", .(mean(arr_delay), mean(dep_delay)), by = .(origin, dest, month)] ans

#### {.bs-callout .bs-callout-info}

• We did not provide column names for expressions in j, they were automatically generated (V1, V2).

• Once again, note that the input order of grouping columns is preserved in the result.

#

Now what if we would like to order the result by those grouping columns origin, dest and month?

### b) keyby

data.table retaining the original order of groups is intentional and by design. There are cases when preserving the original order is essential. But at times we would like to automatically sort by the variables we grouped by.

#### -- So how can we directly order by all the grouping variables?

ans <- flights[carrier == "AA", .(mean(arr_delay), mean(dep_delay)), keyby = .(origin, dest, month)] ans

#### {.bs-callout .bs-callout-info}

• All we did was to change by to keyby. This automatically orders the result by the grouping variables in increasing order. Note that keyby() is applied after performing the operation, i.e., on the computed result.

Keys: Actually keyby does a little more than just ordering. It also sets a key after ordering by setting an attribute called sorted. But we'll learn more about keys in the next vignette.

For now, all you've to know is you can use keyby to automatically order by the columns specified in by.

### c) Chaining

Let's reconsider the task of getting the total number of trips for each origin, dest pair for carrier "AA".

ans <- flights[carrier == "AA", .N, by = .(origin, dest)]

#### -- How can we order ans using the columns origin in ascending order, and dest in descending order?

We can store the intermediate result in a variable, and then use order(origin, -dest) on that variable. It seems fairly straightforward.

ans <- ans[order(origin, -dest)] head(ans)

#### {.bs-callout .bs-callout-info}

• Recall that we can use "-" on a character column in order() within the frame of a data.table. This is possible to due data.table's internal query optimisation.

• Also recall that order(...) with the frame of a data.table is automatically optimised to use data.table's internal fast radix order forder() for speed. So you can keep using the already familiar base R functions without compromising in speed or memory efficiency that data.table offers. We will cover this in more detail in the data.table internals vignette.

#

But this requires having to assign the intermediate result and then overwriting that result. We can do one better and avoid this intermediate assignment on to a variable altogether by chaining expressions.

ans <- flights[carrier == "AA", .N, by = .(origin, dest)][order(origin, -dest)] head(ans, 10)

#### {.bs-callout .bs-callout-info}

• We can tack expressions one after another, forming a chain of operations, i.e., DT[ ... ][ ... ][ ... ].

• Or you can also chain them vertically:

 DT[ ... ][ ... ][ ... ]

### d) Expressions in by

#### -- Can by accept expressions as well or just take columns?

Yes it does. As an example, if we would like to find out how many flights started late but arrived early (or on time), started and arrived late etc...

ans <- flights[, .N, .(dep_delay>0, arr_delay>0)] ans

#### {.bs-callout .bs-callout-info}

• The last row corresponds to dep_delay > 0 = TRUE and arr_delay > 0 = FALSE. We can see that r flights[!is.na(arr_delay) & !is.na(dep_delay), .N, .(dep_delay>0, arr_delay>0)][, N[4L]] flights started late but arrived early (or on time).

• Note that we did not provide any names to by-expression. And names have been automatically assigned in the result.

• You can provide other columns along with expressions, for example: DT[, .N, by = .(a, b>0)].

### e) Multiple columns in j - .SD

#### -- Do we have to compute mean() for each column individually?

It is of course not practical to have to type mean(myCol) for every column one by one. What if you had a 100 columns to compute mean() of?

How can we do this efficiently? To get there, refresh on this tip - "As long as j-expression returns a list, each element of the list will be converted to a column in the resulting data.table". Suppose we can refer to the data subset for each group as a variable while grouping, then we can loop through all the columns of that variable using the already familiar base function lapply(). We don't have to learn any new function.

#### Special symbol .SD: {.bs-callout .bs-callout-info #special-SD}

data.table provides a special symbol, called .SD. It stands for Subset of Data. It by itself is a data.table that holds the data for the current group defined using by.

Recall that a data.table is internally a list as well with all its columns of equal length.

#

Let's use the data.table DT from before to get a glimpse of what .SD looks like.

DT DT[, print(.SD), by = ID]

#### {.bs-callout .bs-callout-info}

• .SD contains all the columns except the grouping columns by default.

• It is also generated by preserving the original order - data corresponding to ID = "b", then ID = "a", and then ID = "c".

#

To compute on (multiple) columns, we can then simply use the base R function lapply().

DT[, lapply(.SD, mean), by = ID]

#### {.bs-callout .bs-callout-info}

• .SD holds the rows corresponding to columns a, b and c for that group. We compute the mean() on each of these columns using the already familiar base function lapply().

• Each group returns a list of three elements containing the mean value which will become the columns of the resulting data.table.

• Since lapply() returns a list, there is no need to wrap it with an additional .() (if necessary, refer to this tip).

#

We are almost there. There is one little thing left to address. In our flights data.table, we only wanted to calculate the mean() of two columns arr_delay and dep_delay. But .SD would contain all the columns other than the grouping variables by default.

#### .SDcols {.bs-callout .bs-callout-info}

Using the argument .SDcols. It accepts either column names or column indices. For example, .SDcols = c("arr_delay", "dep_delay") ensures that .SD contains only these two columns for each group.

Similar to the with = FALSE section, you can also provide the columns to remove instead of columns to keep using - or ! sign as well as select consecutive columns as colA:colB and deselect consecutive columns as !(colA:colB) or-(colA:colB).

# Now let us try to use .SD along with .SDcols to get the mean() of arr_delay and dep_delay columns grouped by origin, dest and month.

flights[carrier == "AA", ## Only on trips with carrier "AA" lapply(.SD, mean), ## compute the mean by = .(origin, dest, month), ## for every 'origin,dest,month' .SDcols = c("arr_delay", "dep_delay")] ## for just those specified in .SDcols

### f) Subset .SD for each group:

#### -- How can we return the first two rows for each month?

ans <- flights[, head(.SD, 2), by = month] head(ans)

#### {.bs-callout .bs-callout-info}

• .SD is a data.table that holds all the rows for that group. We simply subset the first two rows as we have seen here already.

• For each group, head(.SD, 2) returns the first two rows as a data.table which is also a list. So we do not have to wrap it with .().

### g) Why keep j so flexible?

So that we have a consistent syntax and keep using already existing (and familiar) base functions instead of learning new functions. To illustrate, let us use the data.table DT we created at the very beginning under What is a data.table? section.

#### -- How can we concatenate columns a and b for each group in ID?

DT[, .(val = c(a,b)), by = ID]

#### {.bs-callout .bs-callout-info}

• That's it. There is no special syntax required. All we need to know is the base function c() which concatenates vectors and the tip from before.

#### -- What if we would like to have all the values of column a and b concatenated, but returned as a list column?

DT[, .(val = list(c(a,b))), by = ID]

#### {.bs-callout .bs-callout-info}

• Here, we first concatenate the values with c(a,b) for each group, and wrap that with list(). So for each group, we return a list of all concatenated values.

• Note those commas are for display only. A list column can contain any object in each cell, and in this example, each cell is itself a vector and some cells contain longer vectors than others.

# Once you start internalising usage in j, you will realise how powerful the syntax can be. A very useful way to understand it is by playing around, with the help of print().

For example:

## (1) look at the difference between DT[, print(c(a,b)), by = ID] ## (2) and DT[, print(list(c(a,b))), by = ID]

In (1), for each group, a vector is returned, with length = 6,4,2 here. However (2) returns a list of length 1 for each group, with its first element holding vectors of length 6,4,2. Therefore (1) results in a length of 6+4+2 =r 6+4+2, whereas (2) returns 1+1+1=r 1+1+1.

## Summary

The general form of data.table syntax is:

DT[i, j, by]

We have seen so far that,

#### Using i: {.bs-callout .bs-callout-info}

• We can subset rows similar to a data.frame - except you don't have to use DT\$ repetitively since columns within the frame of a data.table are seen as if they are variables.

• We can also sort a data.table using order(), which internally uses data.table's fast order for performance.

We can do much more in i by keying a data.table, which allows blazing fast subsets and joins. We will see this in the "Keys and fast binary search based subsets" and "Joins and rolling joins" vignette.

#### Using j: {.bs-callout .bs-callout-info}

1. Select columns the data.table way: DT[, .(colA, colB)].

2. Select columns the data.frame way: DT[, c("colA", "colB"), with = FALSE].

3. Compute on columns: DT[, .(sum(colA), mean(colB))].

4. Provide names if necessary: DT[, .(sA =sum(colA), mB = mean(colB))].

5. Combine with i: DT[colA > value, sum(colB)].

#

#### Using by: {.bs-callout .bs-callout-info}

• Using by, we can group by columns by specifying a list of columns or a character vector of column names or even expressions. The flexibility of j, combined with by and i makes for a very powerful syntax.

• by can handle multiple columns and also expressions.

• We can keyby grouping columns to automatically sort the grouped result.

• We can use .SD and .SDcols in j to operate on multiple columns using already familiar base functions. Here are some examples:

1. DT[, lapply(.SD, fun), by = ..., .SDcols = ...] - applies fun to all columns specified in .SDcols while grouping by the columns specified in by.

2. DT[, head(.SD, 2), by = ...] - return the first two rows for each group.

3. DT[col > val, head(.SD, 1), by = ...] - combine i along with j and by.

#

#### And remember the tip: {.bs-callout .bs-callout-warning}

As long as j returns a list, each element of the list will become a column in the resulting data.table.

#

We will see how to add/update/delete columns by reference and how to combine them with i and by in the next vignette.