Update documentation
authorPaul Hoffman <phoffman@nygenome.org>
Sun, 22 Apr 2018 23:27:02 +0000 (19:27 -0400)
committerPaul Hoffman <phoffman@nygenome.org>
Sun, 22 Apr 2018 23:27:02 +0000 (19:27 -0400)
R/loom.R
man/combine.Rd
man/connect.Rd
man/create.Rd
man/loom-class.Rd [deleted file]
man/loom.Rd [new file with mode: 0644]
man/subset.loom.Rd

index 888928d1d8026d6cd9cd9c7858cf666ecfcd0c09..98e7d05cb73a1be32bae1c7695a90d75f97742aa 100644 (file)
--- a/R/loom.R
+++ b/R/loom.R
@@ -4,15 +4,16 @@
 #' @importFrom R6 R6Class
 NULL
 
-#' A class for loom files
+#' A class for connections loom files
+#'
 #'
 #' @docType class
-#' @name loom-class
-#' @rdname loom-class
-#' @aliases loom
-#' @return Object of \code{\link{R6::R6Class}} to generate \code{loom} objects
+#' @name loom
+#' @rdname loom
+#' @usage lfile <- loomR::connect(filename = 'myfile.loom')
+#' @aliases loom-class
 #' @format An \code{\link{R6::R6Class}} object
-#' @seealso \code{\link{hdf5r::H5File}}
+#' @seealso \code{\link{loomR}}, \code{\link{hdf5r::H5File}}
 #'
 #' @field version Version of loomR object was created under
 #' @field shape Shape of \code{/matrix} in genes (columns) by cells (rows)
@@ -1270,7 +1271,7 @@ loom <- R6Class(
 #'
 #' @importFrom utils packageVersion txtProgressBar setTxtProgressBar
 #'
-#' @seealso \code{\link{loom-class}}
+#' @seealso \code{\link{loom}}
 #'
 #' @export
 #'
@@ -1407,7 +1408,7 @@ create <- function(
 #'
 #' @return A loom file connection
 #'
-#' @seealso \code{\link{loom-class}}
+#' @seealso \code{\link{loom}}
 #'
 #' @export
 #'
@@ -1436,6 +1437,8 @@ connect <- function(filename, mode = "r", skip.validate = FALSE) {
 #'
 #' @importFrom utils setTxtProgressBar
 #'
+#' @seealso \code{\link{loom}}
+#'
 #' @export subset.loom
 #' @method subset loom
 #'
@@ -1678,9 +1681,9 @@ subset.loom <- function(
 
 #' Combine loom files
 #'
-#' @param looms A list of loom files or filenames
+#' @param looms A list of \code{loom} objects or paths to loom files
 #' @param filename Name for resultant loom file
-#' @param chunk.size How many rows form each input loom should we stream to the merged loom file at any given time?
+#' @param chunk.size How many rows from each input loom should we stream to the merged loom file at any given time?
 #' @param order.by Optional row attribute to order each input loom by, must be one dimensional
 #' @param overwrite Overwrite \code{filename} if already exists?
 #' @param display.progress Display progress as we're copying over data
@@ -1689,7 +1692,7 @@ subset.loom <- function(
 #'
 #' @importFrom utils setTxtProgressBar
 #'
-#' @seealso \code{\link{loom-class}}
+#' @seealso \code{\link{loom}}
 #'
 #' @export
 #'
index 15b84545d7874b2c0f5f37cf5612f17bc4dac3e9..2fa6fcf07f949765314c667a4fad1050ecf8b09c 100644 (file)
@@ -8,11 +8,11 @@ combine(looms, filename, chunk.size = 1000, order.by = NULL,
   overwrite = FALSE, display.progress = TRUE, ...)
 }
 \arguments{
-\item{looms}{A list of loom files or filenames}
+\item{looms}{A list of \code{loom} objects or paths to loom files}
 
 \item{filename}{Name for resultant loom file}
 
-\item{chunk.size}{How many rows form each input loom should we stream to the merged loom file at any given time?}
+\item{chunk.size}{How many rows from each input loom should we stream to the merged loom file at any given time?}
 
 \item{order.by}{Optional row attribute to order each input loom by, must be one dimensional}
 
@@ -27,5 +27,5 @@ A loom object connected to \code{filename}
 Combine loom files
 }
 \seealso{
-\code{\link{loom-class}}
+\code{\link{loom}}
 }
index 6d4df0e0475af000a16ab3250055ff5f7ea2117e..b8e992365588c1549582cc79aa48013efad28e56 100644 (file)
@@ -21,5 +21,5 @@ A loom file connection
 Connect to a loom file
 }
 \seealso{
-\code{\link{loom-class}}
+\code{\link{loom}}
 }
index 12978059afe77b5ee6b906e76fe94632fe96c7b9..4497710d608b9a5d22591b1c34859cc03da34f17 100644 (file)
@@ -36,5 +36,5 @@ A connection to a loom file
 Create a loom object
 }
 \seealso{
-\code{\link{loom-class}}
+\code{\link{loom}}
 }
diff --git a/man/loom-class.Rd b/man/loom-class.Rd
deleted file mode 100644 (file)
index 4a7d206..0000000
+++ /dev/null
@@ -1,152 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/loom.R
-\docType{class}
-\name{loom-class}
-\alias{loom-class}
-\alias{loom}
-\title{A class for loom files}
-\format{An \code{\link{R6::R6Class}} object}
-\usage{
-loom
-}
-\value{
-Object of \code{\link{R6::R6Class}} to generate \code{loom} objects
-}
-\description{
-A class for loom files
-}
-\section{Fields}{
-
-\describe{
-\item{\code{version}}{Version of loomR object was created under}
-
-\item{\code{shape}}{Shape of \code{/matrix} in genes (columns) by cells (rows)}
-
-\item{\code{chunksize}}{Chunks set for this dataset in columns (cells) by rows (genes)}
-
-\item{\code{matrix}}{The main data matrix, stored as columns (cells) by rows (genes)}
-
-\item{\code{layers}}{Additional data matricies, the same shape as \code{/matrix}}
-
-\item{\code{col.attrs}}{Extra information about cells}
-
-\item{\code{row.attrs}}{Extra information about genes}
-}}
-
-\section{Methods}{
-
-\describe{
-  \item{\code{add.graph(a, b, w, name, MARGIN, overwrite)}, \code{add.graph.matrix(mat, name, MARGIN, overwrite)}}{
-    Add a graph to the loom object; can add either in coorindate format (\code{add.graph}) or matrix format (\code{add.graph.matrix}).
-    Stores graph in coordinate format as \code{[row, col]_graphs/name/a} (row indices),
-    \code{[row, col]_graphs/name/b} (column indices), and \code{[row, col]_graphs/name/w} (values)
-    \describe{
-      \item{\code{a}}{Integer vector of row indices for graph, must be the same lengths as \code{b} and \code{w}}
-      \item{\code{b}}{Integer vector of column indices for graph, must be the same lengths as \code{a} and \code{w}}
-      \item{\code{w}}{Numeric vector of values for graph, must be the same lengths as \code{a} and \code{b}}
-      \item{\code{mat}}{Graph provided as a matrix (sparse or dense) or data.frame}
-      \item{\code{name}}{Name to store graph, will end up being \code{col_graphs/name} or \code{row_graphs/name}, depending on \code{MARGIN}}
-      \item{\code{MARGIN}}{Store the graph in \code{row_graphs} (1) or \code{col_graphs} (2), defaults to 2}
-      \item{\code{overwrite}}{Can overwrite existing graph?}
-    }
-  }
-  \item{\code{add.layer(layer, chunk.size, overwrite)}}{
-    Add a data layer to this loom file, must be the same dimensions as \code{/matrix}
-    \describe{
-      \item{\code{layer}}{A named list of matrices to be added as layers}
-      \item{\code{chunk.size}}{Number of rows from each layer to stream at once, defaults to 1000}
-      \item{\code{overwrite}}{If a layer already exists, overwrite with new data, defaults to FALSE}
-    }
-  }
-  \item{\code{add.attribute(attribute, MARGIN, overwrite)}}{
-    Add extra information to this loom file.
-    \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), add.col.attribute(attribute)}}{
-    Add row or column attributes
-  }
-  \item{\code{get.attribute.df(MARGIN, attribute.names, row.names, col.names)}}{
-    Get a group of row or column attributes as a data frame, will only return attributes that have one dimension
-    \describe{
-      \item{\code{MARGIN}}{Either '1' or '2' to get row- or column-attributes, respectively}
-      \item{\code{attribute.names}}{A vector of attribute dataset basenames}
-      \item{\code{row.names}}{Basename of the rownames dataset}
-      \item{\code{col.names}}{Basename of the colnames dataset}
-    }
-  }
-  \item{\code{get.graph(name, MARGIN)}}{
-    Get a graph as a sparse matrix
-    \describe{
-      \item{\code{name}}{Name of the graph, can be either the basename or full name of the grpah}
-      \item{\code{MARGIN}}{
-        Load the graph from \code{row_graphs} (1) or \code{col_graphs} (2), defaults to 2.
-        Ignored if full path to graph is passed to \code{name}
-      }
-    }
-  }
-  \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}.
-    \describe{
-      \item{\code{chunk.size}}{Size to chunk \code{MARGIN} by, defaults to \code{self$chunksize}}
-      \item{\code{MARGIN}}{Iterate over genes (1) or cells (2), defaults to 2}
-      \item{\code{index.use}}{Which specific values of \code{dataset.use} to use, defaults to \code{1:self$shape[MARGIN]} (all values)}
-      \item{\code{dataset.use}}{Name of dataset to use, can be the name, not \code{group/name}, unless the name is present in multiple groups}
-      \item{\code{force.reset}}{Force a reset of the internal iterator}
-      \item{\code{return.data}}{Return data for a given chunk, if \code{FALSE}, returns the indices across \code{MARGIN} for said chunk}
-    }
-  }
-  \item{\code{apply(name, FUN, MARGIN, chunk.size, dataset.use, overwrite, display.progress, ...)}}{
-    Apply a function over a dataset within the loom file, stores the results in the loom file. Will not make multidimensional attributes.
-    \describe{
-      \item{\code{name}}{Full name ('group/name')of dataset to store results to}
-      \item{\code{FUN}}{Function to apply}
-      \item{\code{MARGIN}}{Iterate over genes (1) or cells (2), defaults to 2}
-      \item{\code{index.use}}{Which specific values of \code{dataset.use} to use, defaults to \code{1:self$shape[MARGIN]} (all values)}
-      \item{\code{chunk.size}}{Size to chunk \code{MARGIN} by, defaults to \code{self$chunksize}}
-      \item{\code{dataset.use}}{Name of dataset to use}
-      \item{\code{overwrite}}{Overite \code{name} if already exists}
-      \item{\code{display.progress}}{Display progress}
-      \item{\code{...}}{Extra parameters to pass to \code{FUN}}
-    }
-  }
-  \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.
-    \describe{
-      \item{\code{FUN}}{}
-      \item{\code{MARGIN}}{Iterate over genes (1) or cells (2), defaults to 2}
-      \item{\code{chunk.size}}{Size to chunk \code{MARGIN} by, defaults to \code{self$chunksize}}
-      \item{\code{index.use}}{Which specific values of \code{dataset.use} to use, defaults to \code{1:self$shape[MARGIN]} (all values)}
-      \item{\code{dataset.use}}{Name of dataset to use}
-      \item{\code{display.progress}}{Display progress}
-      \item{\code{...}}{Extra parameters to pass to \code{FUN}}
-    }
-  }
-  \item{\code{add.cells(matrix.data, attributes.data = NULL, layers.data = NULL, display.progress = TRUE)}}{
-    Add cells to a loom file.
-    \describe{
-      \item{\code{matrix.data}}{A list of m2 cells where each entry is a vector of length n (num genes, \code{self$shape[1]})}
-      \item{\code{attributes.data}}{A list where each entry is named for one of the datasets in \code{self[['col_attrs']]}; each entry is a vector of length m2.}
-      \item{\code{layers.data}}{A list where each entry is named for one of the datasets in \code{self[['layers']]}; each entry is an n-by-m2 matrix where n is the number of genes in this loom file and m2 is the number of cells being added.}
-      \item{\code{display.progress}}{Display progress}
-    }
-  }
-  \item{\code{add.loom(other, other.key, self.key, ...)}}{
-    Add the contents of another loom file to this one.
-    \describe{
-      \item{\code{other}}{An object of class \code{loom} or a filename of another loom file}
-      \item{\code{other.key}}{Row attribute in \code{other} to add by}
-      \item{\code{self.key}}{Row attribute in this loom file to add by}
-      \item{\code{...}}{Ignored for now}
-    }
-  }
-}
-}
-
-\seealso{
-\code{\link{hdf5r::H5File}}
-}
-\keyword{datasets}
diff --git a/man/loom.Rd b/man/loom.Rd
new file mode 100644 (file)
index 0000000..8b886e9
--- /dev/null
@@ -0,0 +1,149 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/loom.R
+\docType{class}
+\name{loom}
+\alias{loom}
+\alias{loom-class}
+\title{A class for connections loom files}
+\format{An \code{\link{R6::R6Class}} object}
+\usage{
+lfile <- loomR::connect(filename = 'myfile.loom')
+}
+\description{
+A class for connections loom files
+}
+\section{Fields}{
+
+\describe{
+\item{\code{version}}{Version of loomR object was created under}
+
+\item{\code{shape}}{Shape of \code{/matrix} in genes (columns) by cells (rows)}
+
+\item{\code{chunksize}}{Chunks set for this dataset in columns (cells) by rows (genes)}
+
+\item{\code{matrix}}{The main data matrix, stored as columns (cells) by rows (genes)}
+
+\item{\code{layers}}{Additional data matricies, the same shape as \code{/matrix}}
+
+\item{\code{col.attrs}}{Extra information about cells}
+
+\item{\code{row.attrs}}{Extra information about genes}
+}}
+
+\section{Methods}{
+
+\describe{
+  \item{\code{add.graph(a, b, w, name, MARGIN, overwrite)}, \code{add.graph.matrix(mat, name, MARGIN, overwrite)}}{
+    Add a graph to the loom object; can add either in coorindate format (\code{add.graph}) or matrix format (\code{add.graph.matrix}).
+    Stores graph in coordinate format as \code{[row, col]_graphs/name/a} (row indices),
+    \code{[row, col]_graphs/name/b} (column indices), and \code{[row, col]_graphs/name/w} (values)
+    \describe{
+      \item{\code{a}}{Integer vector of row indices for graph, must be the same lengths as \code{b} and \code{w}}
+      \item{\code{b}}{Integer vector of column indices for graph, must be the same lengths as \code{a} and \code{w}}
+      \item{\code{w}}{Numeric vector of values for graph, must be the same lengths as \code{a} and \code{b}}
+      \item{\code{mat}}{Graph provided as a matrix (sparse or dense) or data.frame}
+      \item{\code{name}}{Name to store graph, will end up being \code{col_graphs/name} or \code{row_graphs/name}, depending on \code{MARGIN}}
+      \item{\code{MARGIN}}{Store the graph in \code{row_graphs} (1) or \code{col_graphs} (2), defaults to 2}
+      \item{\code{overwrite}}{Can overwrite existing graph?}
+    }
+  }
+  \item{\code{add.layer(layer, chunk.size, overwrite)}}{
+    Add a data layer to this loom file, must be the same dimensions as \code{/matrix}
+    \describe{
+      \item{\code{layer}}{A named list of matrices to be added as layers}
+      \item{\code{chunk.size}}{Number of rows from each layer to stream at once, defaults to 1000}
+      \item{\code{overwrite}}{If a layer already exists, overwrite with new data, defaults to FALSE}
+    }
+  }
+  \item{\code{add.attribute(attribute, MARGIN, overwrite)}}{
+    Add extra information to this loom file.
+    \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), add.col.attribute(attribute)}}{
+    Add row or column attributes
+  }
+  \item{\code{get.attribute.df(MARGIN, attribute.names, row.names, col.names)}}{
+    Get a group of row or column attributes as a data frame, will only return attributes that have one dimension
+    \describe{
+      \item{\code{MARGIN}}{Either '1' or '2' to get row- or column-attributes, respectively}
+      \item{\code{attribute.names}}{A vector of attribute dataset basenames}
+      \item{\code{row.names}}{Basename of the rownames dataset}
+      \item{\code{col.names}}{Basename of the colnames dataset}
+    }
+  }
+  \item{\code{get.graph(name, MARGIN)}}{
+    Get a graph as a sparse matrix
+    \describe{
+      \item{\code{name}}{Name of the graph, can be either the basename or full name of the grpah}
+      \item{\code{MARGIN}}{
+        Load the graph from \code{row_graphs} (1) or \code{col_graphs} (2), defaults to 2.
+        Ignored if full path to graph is passed to \code{name}
+      }
+    }
+  }
+  \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}.
+    \describe{
+      \item{\code{chunk.size}}{Size to chunk \code{MARGIN} by, defaults to \code{self$chunksize}}
+      \item{\code{MARGIN}}{Iterate over genes (1) or cells (2), defaults to 2}
+      \item{\code{index.use}}{Which specific values of \code{dataset.use} to use, defaults to \code{1:self$shape[MARGIN]} (all values)}
+      \item{\code{dataset.use}}{Name of dataset to use, can be the name, not \code{group/name}, unless the name is present in multiple groups}
+      \item{\code{force.reset}}{Force a reset of the internal iterator}
+      \item{\code{return.data}}{Return data for a given chunk, if \code{FALSE}, returns the indices across \code{MARGIN} for said chunk}
+    }
+  }
+  \item{\code{apply(name, FUN, MARGIN, chunk.size, dataset.use, overwrite, display.progress, ...)}}{
+    Apply a function over a dataset within the loom file, stores the results in the loom file. Will not make multidimensional attributes.
+    \describe{
+      \item{\code{name}}{Full name ('group/name')of dataset to store results to}
+      \item{\code{FUN}}{Function to apply}
+      \item{\code{MARGIN}}{Iterate over genes (1) or cells (2), defaults to 2}
+      \item{\code{index.use}}{Which specific values of \code{dataset.use} to use, defaults to \code{1:self$shape[MARGIN]} (all values)}
+      \item{\code{chunk.size}}{Size to chunk \code{MARGIN} by, defaults to \code{self$chunksize}}
+      \item{\code{dataset.use}}{Name of dataset to use}
+      \item{\code{overwrite}}{Overite \code{name} if already exists}
+      \item{\code{display.progress}}{Display progress}
+      \item{\code{...}}{Extra parameters to pass to \code{FUN}}
+    }
+  }
+  \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.
+    \describe{
+      \item{\code{FUN}}{}
+      \item{\code{MARGIN}}{Iterate over genes (1) or cells (2), defaults to 2}
+      \item{\code{chunk.size}}{Size to chunk \code{MARGIN} by, defaults to \code{self$chunksize}}
+      \item{\code{index.use}}{Which specific values of \code{dataset.use} to use, defaults to \code{1:self$shape[MARGIN]} (all values)}
+      \item{\code{dataset.use}}{Name of dataset to use}
+      \item{\code{display.progress}}{Display progress}
+      \item{\code{...}}{Extra parameters to pass to \code{FUN}}
+    }
+  }
+  \item{\code{add.cells(matrix.data, attributes.data = NULL, layers.data = NULL, display.progress = TRUE)}}{
+    Add cells to a loom file.
+    \describe{
+      \item{\code{matrix.data}}{A list of m2 cells where each entry is a vector of length n (num genes, \code{self$shape[1]})}
+      \item{\code{attributes.data}}{A list where each entry is named for one of the datasets in \code{self[['col_attrs']]}; each entry is a vector of length m2.}
+      \item{\code{layers.data}}{A list where each entry is named for one of the datasets in \code{self[['layers']]}; each entry is an n-by-m2 matrix where n is the number of genes in this loom file and m2 is the number of cells being added.}
+      \item{\code{display.progress}}{Display progress}
+    }
+  }
+  \item{\code{add.loom(other, other.key, self.key, ...)}}{
+    Add the contents of another loom file to this one.
+    \describe{
+      \item{\code{other}}{An object of class \code{loom} or a filename of another loom file}
+      \item{\code{other.key}}{Row attribute in \code{other} to add by}
+      \item{\code{self.key}}{Row attribute in this loom file to add by}
+      \item{\code{...}}{Ignored for now}
+    }
+  }
+}
+}
+
+\seealso{
+\code{\link{loomR}}, \code{\link{hdf5r::H5File}}
+}
+\keyword{datasets}
index 07cb0c30aa179d731fd2eb64664a8205944196c8..9abff4dda447c2c4f2b14c80960f6ad226a2bd66 100644 (file)
@@ -31,3 +31,6 @@ A loom object connected to \code{filename}
 \description{
 Subset a loom file
 }
+\seealso{
+\code{\link{loom}}
+}