Update documentation
authorPaul Hoffman <phoffman@nygenome.org>
Mon, 6 Nov 2017 19:40:55 +0000 (14:40 -0500)
committerPaul Hoffman <phoffman@nygenome.org>
Mon, 6 Nov 2017 19:40:55 +0000 (14:40 -0500)
R/loom.R
man/loom-class.Rd

index 2b640f9d683d347fdf09bc281c8fe97b8c72f70c..2590b0601c7695b68dd5aa7b2eea7a152ca555ff 100644 (file)
--- a/R/loom.R
+++ b/R/loom.R
@@ -40,8 +40,15 @@ NULL
 #'     \code{chunk.size} defaults to \code{self$chunksize}, \code{MARGIN} defaults to 1,
 #'     \code{index.use} defaults to \code{1:self$shape[MARGIN]}, \code{dataset.use} defaults to 'matrix'
 #'   }
-#'   \item{\code{apply(name, FUN, MARGIN, chunk.size, index.use, dataset.use, display.progress, expected, ...)}}{...}
-#'   \item{\code{map(FUN, MARGIN, chunk.size, index.use, dataset.use, display.progress, expected, ...)}}{...}
+#'   \item{\code{apply(name, FUN, MARGIN, chunk.size, dataset.use, display.progress, ...)}}{
+#'     Apply a function over a dataset within the loom file, stores the results in the loom file.
+#'     \code{name} must be the full name of the dataset ('group/name').
+#'     \code{apply} will always use the entire dataset specified in \code{dataset.use}
+#'   }
+#'   \item{\code{map(FUN, MARGIN, chunk.size, index.use, dataset.use, display.progress, expected, ...)}}{
+#'     Map a function onto a dataset within the loom file, returns the result into R.
+#'     The result will default to the shape of the dataset used; to change pass either 'vector' or 'matrix' to \code{expected}.
+#'   }
 #' }
 #'
 #' @importFrom iterators nextElem
index f38718e435ba2dffbe842a445897ed960ad49d2b..9c3fcd3dc836b5bcc713dcec965839e086ebf2ba 100644 (file)
@@ -54,8 +54,15 @@ A class for loom files
     \code{chunk.size} defaults to \code{self$chunksize}, \code{MARGIN} defaults to 1,
     \code{index.use} defaults to \code{1:self$shape[MARGIN]}, \code{dataset.use} defaults to 'matrix'
   }
-  \item{\code{apply(name, FUN, MARGIN, chunk.size, index.use, dataset.use, display.progress, expected, ...)}}{...}
-  \item{\code{map(FUN, MARGIN, chunk.size, index.use, dataset.use, display.progress, expected, ...)}}{...}
+  \item{\code{apply(name, FUN, MARGIN, chunk.size, dataset.use, display.progress, ...)}}{
+    Apply a function over a dataset within the loom file, stores the results in the loom file.
+    \code{name} must be the full name of the dataset ('group/name').
+    \code{apply} will always use the entire dataset specified in \code{dataset.use}
+  }
+  \item{\code{map(FUN, MARGIN, chunk.size, index.use, dataset.use, display.progress, expected, ...)}}{
+    Map a function onto a dataset within the loom file, returns the result into R.
+    The result will default to the shape of the dataset used; to change pass either 'vector' or 'matrix' to \code{expected}.
+  }
 }
 }