remove extra comma, rerun docs
authorandrewwbutler <andrew.butler33@gmail.com>
Wed, 7 Feb 2018 22:46:01 +0000 (17:46 -0500)
committerandrewwbutler <andrew.butler33@gmail.com>
Wed, 7 Feb 2018 22:46:01 +0000 (17:46 -0500)
R/loom.R
man/create.Rd
man/loom-class.Rd

index 641fe48172a3aef4960f42f96faea6a56b6e0b69..d54b16f4cd31c27d3b3358c5e4a6cf35dee0fa81 100644 (file)
--- a/R/loom.R
+++ b/R/loom.R
@@ -969,7 +969,7 @@ create <- function(
   chunk.dims = 'auto',
   chunk.size = 10,
   overwrite = FALSE,
-  display.progress = TRUE,
+  display.progress = TRUE
 ) {
   mode <- ifelse(test = overwrite, yes = 'w', no = 'w-')
   if (file.exists(filename) && !overwrite) {
index 07e4bf6e47fb0fcce8b9675c2ea6fad282182874..8d47fa34ee04de380d07e534ca0de00ce90d364e 100644 (file)
@@ -5,7 +5,8 @@
 \title{Create a loom object}
 \usage{
 create(filename, data, gene.attrs = NULL, cell.attrs = NULL,
-  layers = NULL, chunk.dims = "auto", overwrite = FALSE)
+  layers = NULL, chunk.dims = "auto", chunk.size = 10,
+  overwrite = FALSE, display.progress = TRUE)
 }
 \arguments{
 \item{filename}{The name of the new loom file}
index 9828ec9444ae026daaaedfaf6eeabb38989b4387..01758d1cc1ce8feb5f1ba087b35af0fd1a72a357 100644 (file)
@@ -39,18 +39,14 @@ A class for loom files
   \item{\code{add.layer(layer, overwrite)}}{Add a data layer to this loom file, must be the same dimensions as \code{/matrix}}
   \item{\code{add.attribute(attribute, MARGIN, overwrite)}}{
     Add extra information to this loom file where
-    \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 genes or 2 for cells, and
-    \code{overwrite} tells us whether we can overwrite existing attributes or not
+    \describe{
+      \item{\code{attribute}}{A named list where the first dimmension of each element as long as one dimension of \code{/matrix}}
+      \item{\code{MARGIN}}{Either 1 for genes or 2 for cells}
+      \item{\code{overwrite}}{Can overwrite existing attributes?}
+    }
   }
   \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{get.attribute.df(attribute.layer, attribute.names, row.names, col.names)}}{
-    Extract a data.frame of \code{attribute.names} from an \code{attribute.layer} ("row" - row_attrs or "col" - col_attrs).
-    Returns a data.frame into memory with \code{attribute.names} as the columns.
-    Removes rows that are entirely composed of NA values.
-  }
   \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.