d574d88a3ee6234233b7ac4383fa5d0e66bff36f
[loomr.git] / man / loom-class.Rd
1 % Generated by roxygen2: do not edit by hand
2 % Please edit documentation in R/loom.R
3 \docType{class}
4 \name{loom-class}
5 \alias{loom-class}
6 \alias{loom}
7 \title{A class for loom files}
8 \format{An \code{\link{R6::R6Class}} object}
9 \usage{
10 loom
11 }
12 \value{
13 Object of \code{\link{R6::R6Class}} to generate \code{loom} objects
14 }
15 \description{
16 A class for loom files
17 }
18 \section{Fields}{
19
20 \describe{
21 \item{\code{version}}{Version of loomR object was created under}
22
23 \item{\code{shape}}{Shape of \code{/matrix} in columns (cells) by rows (genes)}
24
25 \item{\code{chunksize}}{Chunks set for this dataset in columns (cells) by rows (genes)}
26
27 \item{\code{matrix}}{The main data matrix, stored as columns (cells) by rows (genes)}
28
29 \item{\code{layers}}{Additional data matricies, the same shape as \code{/matrix}}
30
31 \item{\code{col.attrs}}{Extra information about cells}
32
33 \item{\code{row.attrs}}{Extra information about genes}
34 }}
35
36 \section{Methods}{
37
38 \describe{
39   \item{\code{add.layer(layer)}}{Add a data layer to this loom file, must be in column (cells) by row (genes) orientation}
40   \item{\code{add.attribute(attribute, MARGIN)}}{
41     Add extra information to this loom file where
42     \code{attribute} is a named list where each element is a vector that is as long as one dimension of \code{/matrix} and
43     \code{MARGIN} is either 1 for cells or 2 for genes
44   }
45   \item{\code{add.row.attribute(attribute)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 2)}}
46   \item{\code{add.col.attribute(attribute)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 1)}}
47   \item{\code{add.meta.data(meta.data)}}{A wrapper for \code{add.attribute(attribute, MARGIN = 1)}}
48   \item{\code{batch.scan(chunk.size, MARGIN, index.use, dataset.use)}, \code{batch.next()}}{
49     Scan a dataset in the loom file from \code{index.use[1]} to \code{index.use[2]}, iterating by \code{chunk.size}.
50     \code{dataset.use} can be the name, not \code{group/name}, unless the name is present in multiple groups.
51     If the dataset is in col_attrs, pass \code{MARGIN = 1}; if in row_attrs, pass \code{MARGIN = 2}.
52     Otherwise, pass \code{MARGIN = 1} to iterate on cells or \code{MARGIN = 2} to iterate on genes.
53     \code{chunk.size} defaults to \code{self$chunksize}, \code{MARGIN} defaults to 1,
54     \code{index.use} defaults to \code{1:self$shape[MARGIN]}, \code{dataset.use} defaults to 'matrix'
55   }
56 }
57 }
58
59 \seealso{
60 \code{\link{hdf5r::H5File}}
61 }
62 \keyword{datasets}