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