Allow method chaining
[loomr.git] / R / loom.R
1 #' @import hdf5r
2 #' @importFrom R6 R6Class
3 NULL
4
5 #' A class for loom files
6 #'
7 #' @docType class
8 #' @name loom-class
9 #' @rdname loom-class
10 #' @return Object of \code{\link{R6::R6Class}} to generate \code{loom} objects
11 #' @format An \code{\link{R6::R6Class}} object
12 #' @seealso \code{\link{hdf5r::H5File}}
13 #'
14 #' @field version Version of loomR object was created under
15 #' @field shape Shape of \code{/matrix} in columns (cells) by rows (genes)
16 #' @field chunksize Chunks set for this dataset in columns (cells) by rows (genes)
17 #' @field matrix The main data matrix, stored as columns (cells) by rows (genes)
18 #' @field layers Additional data matricies, the same shape as \code{/matrix}
19 #' @field col.attrs Extra information about cells
20 #' @field row.attrs Extra information about genes
21 #'
22 #' @section Methods:
23 #' \describe{
24 #'   \item{\code{add.layer(layer)}}{Add a data layer to this loom file, must be in column (cells) by row (genes) orientation}
25 #'   \item{\code{add.attribute(attribute, MARGIN)}}{Add extra information to this loom file; \code{attribute} is a named list where each element is a vector that is as long as one dimension of \code{/matrix}, \code{MARGIN} is either 1 for cells or 2 for genes}
26 #'   \item{\code{add.row.attribute(attribute)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 2)}}
27 #'   \item{\code{add.col.attribute(attribute)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 1)}}
28 #'   \item{\code{add.meta.data(meta.data)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 1)}}
29 #' }
30 #'
31 #' @importFrom utils packageVersion
32 #'
33 #' @export
34 #'
35 loom <- R6Class(
36   # The loom class
37   # Based on the H5File class from hdf5r
38   # Not clonable (no loom$clone method), doesn't make sense since all data is on disk, not in memory
39   # Yes to portability, other packages can subclass the loom class
40   # Class is locked, other fields and methods cannot be added
41   classname = 'loom',
42   inherit = hdf5r::H5File,
43   cloneable = FALSE,
44   portable = TRUE,
45   lock_class = TRUE,
46   # Public fields and methods
47   # See above for documentation
48   public = list(
49     # Fields
50     version = NULL,
51     shape = NULL,
52     chunksize = NULL,
53     matrix = NULL,
54     layers = NULL,
55     col.attrs = NULL,
56     row.attrs = NULL,
57     # Methods
58     initialize = function(filename = NULL, mode = c('a', 'r', 'r+', 'w', 'w-'), ...) {
59       # If the file exists, run validation steps
60       do.validate <- file.exists(filename) && !(mode %in% c('w', 'w+'))
61       super$initialize(filename = filename, mode = mode, ...)
62       if (do.validate) {
63         # Run the validation steps
64         validateLoom(object = self)
65         # Store the shape of /matrix
66         self$shape <- self[['matrix']]$dims
67         # Store the chunk size
68         chunks <- h5attr(x = self, which = 'chunks')
69         chunks <- gsub(pattern = '(', replacement = '', x = chunks, fixed = TRUE)
70         chunks <- gsub(pattern = ')', replacement = '', x = chunks, fixed = TRUE)
71         chunks <- unlist(x = strsplit(x = chunks, split = ','))
72         self$chunksize <- as.integer(x = chunks)
73         # Store version information
74         self$version <- as.character(x = tryCatch(
75           # Try getting a version
76           # If it doesn't exist, can we write to the file?
77           # If so, store the version as this version of loomR
78           # Otherwise, store the version as NA_character_
79           expr = h5attr(x = self, which = 'version'),
80           error = function(e) {
81             if (mode != 'r') {
82               version <- packageVersion(pkg = 'loomR')
83               h5attr(x = self, which = 'version') <- version
84             } else {
85               version <- NA_character_
86             }
87             return(version)
88           }
89         ))
90         # Load layers
91         private$load_layers()
92         # Load attributes
93         private$load_attributes(MARGIN = 1) # Cells (col_attrs)
94         private$load_attributes(MARGIN = 2) # Genes (row_attrs)
95       } else {
96         # Assume new HDF5 file
97         self$version <- as.character(x = packageVersion(pkg = 'loomR'))
98       }
99     },
100     add.layer = function(layer, name) {
101       # Layers have to be matricies
102       if (!is.matrix(x = layer)) {
103         layer <- as.matrix(x = layer)
104       }
105       if (is.null(x = self$shape)) {
106         stop(private$err_msg)
107       }
108       do.transpose <- FALSE
109       if (any(dim(x = layer) != self$shape)) {
110         if (all(rev(x = dim(x = layer)) == self$shape)) {
111           do.transpose <- TRUE
112         } else {
113           stop(paste(
114             "All layers must have",
115             self$shape[1],
116             "rows for cells and",
117             self$shape[2],
118             "columns for genes"
119           ))
120         }
121       }
122       # Transpose the matrix since hdf5r uses column x row
123       if (do.transpose) {
124         self[['layers', name]] <- t(x = layer)
125       } else {
126         self[[layers, name]] <- layer
127       }
128       self$flush()
129       private$load_layers()
130       invisible(x = self)
131     },
132     add.attribute = function(attribute, MARGIN) {
133       # Value checking
134       if (!is.list(x = attribute) || is.null(x = names(x = attribute))) {
135         stop("'attribute' must be a named list")
136       }
137       if (length(x = attribute) > 1) {
138         for (i in attribute) {
139           if (!is.vector(x = attribute)) {
140             stop("All attributes must be one-dimensional vectors")
141           }
142         }
143       }
144       if (length(x = which(x = names(x = attribute) != '')) != length(x = attribute)) {
145         stop("Not all attributes had names provided")
146       }
147       if (!MARGIN %in% c(1, 2)) {
148         stop("'MARGIN' must be 1 or 2")
149       }
150       # Add the attributes as datasets for our MARGIN's group
151       if (is.null(x = self$shape)) {
152         stop(private$err_msg)
153       }
154       grp.name <- c('col_attrs', 'row_attrs')[MARGIN]
155       grp <- self[[grp.name]]
156       for (i in 1:length(x = attribute)) {
157         if (length(attribute[[i]]) != self$shape[MARGIN])
158           stop(paste(
159             "All",
160             switch(EXPR = MARGIN, '1' = 'cell', '2' = 'gene'),
161             "attributes must be of length",
162             self$shape[MARGIN]
163           ))
164         grp[[names(x = attribute)[i]]] <- attribute[[i]]
165       }
166       self$flush()
167       gc(verbose = FALSE)
168       # Load the attributes for this margin
169       private$load_attributes(MARGIN = MARGIN)
170       invisible(x = self)
171     },
172     # Add attributes for genes
173     add.row.attribute = function(attribute) {
174       self$add.attribute(attribute = attribute, MARGIN = 2)
175       invisible(x = self)
176     },
177     # Add attributes for cells
178     add.col.attribute = function(attribute) {
179       self$add.attribute(attribute = attribute, MARGIN = 1)
180       invisible(x = self)
181     },
182     # Add metadata, follows cells
183     add.meta.data = function(meta.data) {
184       self$add.col.attribute(attribute = meta.data)
185       invisible(x = self)
186     }
187   ),
188   # Private fields and methods
189   # @field err_msg A simple error message if this object hasn't been created with loomR::create or loomR::connect
190   # \describe{
191   #   \item{\code{load_attributes(MARGIN)}}{Load attributes of a given MARGIN into \code{self$col.attrs} or \code{self$row.attrs}}
192   #   \item{\code{load_layers()}}{Load layers into \code{self$layers}}
193   # }
194   private = list(
195     # Fields
196     err_msg = "This loom object has not been created with either loomR::create or loomR::connect, please use these function to create or connect to a loom file",
197     # Methods
198     load_attributes = function(MARGIN) {
199       attribute <- switch(
200         EXPR = MARGIN,
201         '1' = 'col_attrs',
202         '2' = 'row_attrs',
203         stop('Invalid attribute dimension')
204       )
205       group <- self[[attribute]]
206       attributes <- unlist(x = lapply(
207         X = names(x = group),
208         FUN = function(x) {
209           d <- list(group[[x]])
210           names(x = d) <- x
211           return(d)
212         }
213       ))
214       if (MARGIN == 1) {
215         self$col.attrs <- attributes
216       } else if (MARGIN == 2) {
217         self$row.attrs <- attributes
218       }
219     },
220     load_layers = function() {
221       self$layers <- unlist(x = lapply(
222         X = names(x = self[['layers']]),
223         FUN = function(n) {
224           d <- c(self[['layers', n]])
225           names(x = d) <- n
226           return(d)
227         }
228       ))
229     }
230   )
231 )
232
233 #' Create a loom object
234 #'
235 #' @param filename The name of the new loom file
236 #' @param data The data for \code{/matrix}, should be cells as rows and genes as columns
237 #' @param gene.attrs A named list of vectors with extra data for genes, each vector must be as long as the number of genes in \code{data}
238 #' @param cell.attrs A named list of vectors with extra data for cells, each vector must be as long as the number of cells in \code{data}
239 #' @param chunk.dims A one- or two-length integer vector of chunksizes for \code{/matrix}, defaults to 'auto' to automatically determine chunksize
240 #'
241 #' @return A connection to a loom file
242 #'
243 #' @importFrom utils packageVersion
244 #'
245 #' @seealso \code{\link{loom-class}}
246 #'
247 #' @export
248 #'
249 create <- function(
250   filename,
251   data,
252   gene.attrs = NULL,
253   cell.attrs = NULL,
254   layers = NULL,
255   chunk.dims = 'auto'
256 ) {
257   if (file.exists(filename)) {
258     stop(paste('File', file, 'already exists!'))
259   }
260   if (!is.matrix(x = data)) {
261     data <- as.matrix(x = data)
262   }
263   if (length(x = chunk.dims) > 2 || length(x = chunk.dims) < 1) {
264     stop("'chunk.dims' must be a one- or two-length integer vector or 'auto'")
265   } else if (length(x = chunk.dims == 1)) {
266     if (!grepl(pattern = '^auto$', x = chunk.dims, perl = TRUE)) {
267       chunk.dims <- rep.int(x = as.integer(x = chunk.dims), times = 2)
268     }
269   } else {
270     chunk.dims <- as.integer(x = chunk.dims)
271   }
272   new.loom <- loom$new(filename = filename, mode = 'w-')
273   # Create the matrix
274   new.loom$create_dataset(
275     name = 'matrix',
276     robj = t(x = data),
277     chunk_dims = chunk.dims
278   )
279   new.loom$shape <- new.loom[['matrix']]$dims
280   if (!is.null(x = colnames(x = data))) {
281     new.loom$add.row.attribute(attribute = list('gene_names' = colnames(x = data)))
282   }
283   if (!is.null(x = rownames(x = data))) {
284     new.loom$add.col.attribute(attribute = list('cell_names' = colnames(x = data)))
285   }
286   # Store some constants as HDF5 attributes
287   h5attr(x = new.loom, which = 'version') <- new.loom$version
288   h5attr(x = new.loom, which = 'chunks') <- paste0(
289     '(',
290     paste(new.loom[['matrix']]$chunk_dims, collapse = ', '),
291     ')'
292   )
293   # Groups
294   new.loom$create_group(name = 'layers')
295   new.loom$create_group(name = 'row_attrs')
296   new.loom$create_group(name = 'col_attrs')
297   # Add layers
298   for (ly in layers) {
299     new.loom$add.layer(layer = ly)
300   }
301   if (!is.null(x = gene.attrs)) {
302     new.loom$add.row.attribute(attribute = gene.attrs)
303   }
304   if (!is.null(x = cell.attrs)) {
305     new.loom$add.col.attribute(attribute = cell.attrs)
306   }
307   # Set last bit of information
308   chunks <- new.loom[['matrix']]$chunk_dims
309   chunks <- gsub(pattern = '(', replacement = '', x = chunks, fixed = TRUE)
310   chunks <- gsub(pattern = ')', replacement = '', x = chunks, fixed = TRUE)
311   chunks <- unlist(x = strsplit(x = chunks, split = ','))
312   new.loom$chunksize <- as.integer(x = chunks)
313   # Return the connection
314   return(new.loom)
315 }
316
317 #' Validate a loom object
318 #'
319 #' @param object A loom object
320 #'
321 #' @return None, errors out if object is an invalid loom connection
322 #'
323 #' @seealso \code{\link{loom-class}}
324 #'
325 #' @export
326 #'
327 validateLoom <- function(object) {
328   # A loom file is a specific HDF5
329   # We need a dataset in /matrix that's a two-dimensional dense matrix
330   root.datasets <- list.datasets(object = object, path = '/', recursive = FALSE)
331   if (length(x = root.datasets) != 1) {
332     stop("There can only be one dataset at the root of the loom file")
333   }
334   if (root.datasets != 'matrix') {
335     stop("The root dataset must be called '/matrix'")
336   }
337   # There must be groups called '/col_attrs', '/row_attrs', and '/layers'
338   required.groups <- c('row_attrs', 'col_attrs', 'layers')
339   dim.matrix <- object[[root.datasets]]$dims # Columns x Rows
340   names(x = dim.matrix) <- required.groups[c(2, 1)]
341   root.groups <- list.groups(object = object, path = '/', recursive = FALSE)
342   group.msg <- paste0(
343     "There can only be three groups in the loom file: '",
344     paste(required.groups, collapse = "', '"),
345     "'"
346   )
347   if (length(x = root.groups) != 3) {
348     stop(group.msg)
349   }
350   if (!all(required.groups %in% root.groups)) {
351     stop(group.msg)
352   }
353   unlist(x = sapply(
354     X = required.groups[1:2],
355     FUN = function(group) {
356       if (length(x = list.groups(object = object[[group]], recursive = FALSE)) > 0) {
357         stop(paste("Group", group, "cannot have subgroups"))
358       }
359       if (length(x = list.attributes(object = object[[group]])) > 0) {
360         stop(paste("Group", group, "cannot have subattributes"))
361       }
362       for (dataset in list.datasets(object = object[[group]])) {
363         if (object[[paste(group, dataset, sep = '/')]]$dims != dim.matrix[group]) {
364           stop(paste("All datasets in group", group, "must be of length", required.groups[group]))
365         }
366       }
367     }
368   ))
369   for (dataset in list.datasets(object = object[['/layers']])) {
370     if (any(object[[paste('layers', dataset, sep = '/')]]$dims != dim.matrix)) {
371       stop(paste("All datasets in '/layers' must be", dim.matrix[1], 'by', dim.matrix[2]))
372     }
373   }
374 }
375
376 #' Connect to a loom file
377 #'
378 #' @param filename The loom file to connect to
379 #' @param mode How do we connect to it? Pass 'r' for read-only or 'r+' for read/write
380 #'
381 #' @return A loom file connection
382 #'
383 #' @seealso \code{\link{loom-class}}
384 #'
385 #' @export
386 #'
387 connect <- function(filename, mode = "r") {
388   if (!(mode %in% c('r', 'r+'))) {
389     stop("'mode' must be one of 'r' or 'r+'")
390   }
391   new.loom <- loom$new(filename = filename, mode = mode)
392   return(new.loom)
393 }
394
395 #need to comment
396 #need to add progress bar
397 #but otherwise, pretty cool
398 #for paul to try :
399 # f <- connect("~/Downloads/10X43_1.loom")
400 # mean_var = map(f,f_list = c(mean,var),chunksize = 5000)
401 # nGene <- map(f, f_list = function(x) length(which(x>0)), MARGIN = 2)
402 map <- function(self, f_list = list(mean, var), MARGIN=1, chunksize=1000, selection) {
403   n_func = length(f_list)
404   if (n_func == 1) {
405     f_list <- list(f_list)
406   }
407   if (MARGIN == 1) {
408     results <- list()
409     for (j in 1:n_func) {
410       results[[j]] <- numeric(0)
411     }
412     rows_per_chunk <- chunksize
413     ix <- 1
414     while (ix <= self@shape[1]) {
415       rows_per_chunk <- min(rows_per_chunk, self@shape[1] - ix + 1)
416       chunk <- self["matrix"][ix:(ix + rows_per_chunk - 1), ]
417       for (j in 1:n_func) {
418         new_results <- apply(chunk, 1, FUN = f_list[[j]])
419         results[[j]] <- c(results[[j]], new_results)
420       }
421       ix <- ix + chunksize
422     }
423   }
424   if (MARGIN == 2) {
425     results <- list()
426     for (j in 1:n_func) {
427       results[[j]] <- numeric(0)
428     }
429     cols_per_chunk <- chunksize
430     ix <- 1
431     while (ix <= self@shape[2]) {
432       cols_per_chunk <- min(cols_per_chunk, self@shape[2] - ix + 1)
433       chunk <- self["matrix"][, ix:(ix + cols_per_chunk - 1)]
434       for (j in 1:n_func) {
435         new_results <- apply(chunk, 2, FUN = f_list[[j]])
436         results[[j]] <- c(results[[j]], new_results)
437       }
438       ix <- ix + chunksize
439     }
440   }
441   if (n_func == 1) {
442     results <- results[[1]]
443   }
444   return(results)
445 }