Update documentation
[loomr.git] / man / create.Rd
1 % Generated by roxygen2: do not edit by hand
2 % Please edit documentation in R/loom.R
3 \name{create}
4 \alias{create}
5 \title{Create a loom object}
6 \usage{
7 create(filename, data, gene.attrs = NULL, cell.attrs = NULL,
8   layers = NULL, chunk.dims = "auto", chunk.size = 1000,
9   overwrite = FALSE, display.progress = TRUE)
10 }
11 \arguments{
12 \item{filename}{The name of the new loom file}
13
14 \item{data}{The data for \code{/matrix}, should be cells as rows and genes as columns}
15
16 \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}}
17
18 \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}}
19
20 \item{chunk.dims}{A one- or two-length integer vector of chunksizes for \code{/matrix}, defaults to 'auto' to automatically determine chunksize}
21
22 \item{chunk.size}{How many rows of \code{data} should we stream to the loom file at any given time?}
23
24 \item{overwrite}{Overwrite an already existing loom file?}
25 }
26 \value{
27 A connection to a loom file
28 }
29 \description{
30 Create a loom object
31 }
32 \seealso{
33 \code{\link{loom-class}}
34 }