Add license
[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   do.transpose = TRUE, calc.numi = FALSE, overwrite = FALSE,
10   display.progress = TRUE)
11 }
12 \arguments{
13 \item{filename}{The name of the new loom file}
14
15 \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}}
16
17 \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}}
18
19 \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}}
20
21 \item{chunk.dims}{A one- or two-length integer vector of chunksizes for \code{/matrix}, defaults to 'auto' to automatically determine chunksize}
22
23 \item{chunk.size}{How many rows of \code{data} should we stream to the loom file at any given time?}
24
25 \item{do.transpose}{Transpose the input? Should be \code{TRUE} if \code{data} has genes as rows and cells as columns}
26
27 \item{calc.numi}{Calculate number of UMIs and genes expressed per cell? Will store in 'col_attrs/nUMI' and 'col_attrs/nGene', overwriting anything passed to \code{cel.attrs};
28 To set a custom threshold for gene expression, pass an integer value (eg. \code{calc.numi = 5} for a threshold of five counts per cell)}
29
30 \item{overwrite}{Overwrite an already existing loom file?}
31 }
32 \value{
33 A connection to a loom file
34 }
35 \description{
36 Create a loom object
37 }
38 \seealso{
39 \code{\link{loom}}
40 }