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