Merge branch 'master' of github.com:mojaveazure/loomR
authorPaul Hoffman <phoffman@nygenome.org>
Tue, 14 Nov 2017 19:19:54 +0000 (14:19 -0500)
committerPaul Hoffman <phoffman@nygenome.org>
Tue, 14 Nov 2017 19:19:54 +0000 (14:19 -0500)
R/loom.R
README.md
man/loom-class.Rd

index 2fdd8b7904778a3d9103ba54a7d26413eef42491..8b31f8bafabbe71d9e9718b3761237f116b85921 100644 (file)
--- a/R/loom.R
+++ b/R/loom.R
@@ -29,10 +29,10 @@ NULL
 #'     \code{MARGIN} is either 1 for genes or 2 for cells, and
 #'     \code{overwrite} tells us whether we can overwrite existing attributes or not
 #'   }
-#'   \item{\code{add.row.attribute(attribute)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 2)}}
-#'   \item{\code{add.col.attribute(attribute)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 1)}}
-#'   \item{\code{add.meta.data(meta.data)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 1)}}
-#'   \item{\code{batch.scan(chunk.size, MARGIN, index.use, dataset.use, force.reset)}, \code{batch.next()}}{
+#'   \item{\code{add.row.attribute(attribute)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 1)}}
+#'   \item{\code{add.col.attribute(attribute)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 2)}}
+#'   \item{\code{add.meta.data(meta.data)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 2)}}
+#'   \item{\code{batch.scan(chunk.size, MARGIN, index.use, dataset.use, force.reset)}, \code{batch.next(return.data)}}{
 #'     Scan a dataset in the loom file from \code{index.use[1]} to \code{index.use[2]}, iterating by \code{chunk.size}.
 #'     \code{dataset.use} can be the name, not \code{group/name}, unless the name is present in multiple groups.
 #'     Pass \code{MARGIN = 1} to iterate on genes or \code{MARGIN = 2} to iterate on cells for 'matrix' or any dataset in 'layers'.
@@ -111,7 +111,7 @@ loom <- R6Class(
           error = function(e) {
             if (mode != 'r') {
               version <- packageVersion(pkg = 'loomR')
-              h5attr(x = self, which = 'version') <- version
+              h5attr(x = self, which = 'version') <- as.character(x = version)
             } else {
               version <- NA_character_
             }
index 799392c4d4d03c070debecd394148b96e69ae05d..05c2efdc17164ecfb18ce3986bf6e6c9032bdc45 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,6 +9,10 @@
 
 For more information on loom files, please see the documentation for [loompy](https://github.com/linnarsson-lab/loompy)
 
+## Tutorial
+
+A tutorial for loomR can be found [here](http://satijalab.org/loomR/loomR_tutorial.html). A full function and method reference can be found [here](http://satijalab.org/loomR/loomR.pdf).
+
 ## Compatability with loompy
 
 loomR aims to be completely compatible with loompy. Currently, loomR implements the following methods of the loompy API:
index 70948df9b72a9d85a207e15224542c2c54b883a7..b4128e06f71989b79c2a375f34710676e4e092a0 100644 (file)
@@ -43,10 +43,10 @@ A class for loom files
     \code{MARGIN} is either 1 for genes or 2 for cells, and
     \code{overwrite} tells us whether we can overwrite existing attributes or not
   }
-  \item{\code{add.row.attribute(attribute)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 2)}}
-  \item{\code{add.col.attribute(attribute)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 1)}}
-  \item{\code{add.meta.data(meta.data)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 1)}}
-  \item{\code{batch.scan(chunk.size, MARGIN, index.use, dataset.use, force.reset)}, \code{batch.next()}}{
+  \item{\code{add.row.attribute(attribute)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 1)}}
+  \item{\code{add.col.attribute(attribute)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 2)}}
+  \item{\code{add.meta.data(meta.data)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 2)}}
+  \item{\code{batch.scan(chunk.size, MARGIN, index.use, dataset.use, force.reset)}, \code{batch.next(return.data)}}{
     Scan a dataset in the loom file from \code{index.use[1]} to \code{index.use[2]}, iterating by \code{chunk.size}.
     \code{dataset.use} can be the name, not \code{group/name}, unless the name is present in multiple groups.
     Pass \code{MARGIN = 1} to iterate on genes or \code{MARGIN = 2} to iterate on cells for 'matrix' or any dataset in 'layers'.