Add ability to transpose input data
[loomr.git] / man / create.Rd
index aba9f3784afd5ff0f7062470324d3a80a59b134e..c66670e675b4eb7eff79f86c4c8d4a97354a6f59 100644 (file)
@@ -4,16 +4,26 @@
 \alias{create}
 \title{Create a loom object}
 \usage{
-create(filename, data, row.attrs, col.attrs)
+create(filename, data, gene.attrs = NULL, cell.attrs = NULL,
+  layers = NULL, chunk.dims = "auto", chunk.size = 1000,
+  do.transpose = TRUE, overwrite = FALSE, display.progress = TRUE)
 }
 \arguments{
-\item{filename}{...}
+\item{filename}{The name of the new loom file}
 
-\item{data}{...}
+\item{data}{The data for \code{/matrix}. If cells are rows and genes are columns, set \code{do.transpose = FALSE}; otherwise, set \code{do.transpose = TRUE}}
 
-\item{row.attrs}{...}
+\item{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}}
 
-\item{col.attrs}{...}
+\item{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}}
+
+\item{chunk.dims}{A one- or two-length integer vector of chunksizes for \code{/matrix}, defaults to 'auto' to automatically determine chunksize}
+
+\item{chunk.size}{How many rows of \code{data} should we stream to the loom file at any given time?}
+
+\item{do.transpose}{Transpose the input? Should be \code{TRUE} if \code{data} has rows as genes and cells as columns}
+
+\item{overwrite}{Overwrite an already existing loom file?}
 }
 \value{
 A connection to a loom file