|
a |
|
b/man/scAI-class.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/scAI_model.R |
|
|
3 |
\docType{class} |
|
|
4 |
\name{scAI-class} |
|
|
5 |
\alias{scAI-class} |
|
|
6 |
\alias{scAI} |
|
|
7 |
\title{The scAI Class} |
|
|
8 |
\description{ |
|
|
9 |
The scAI object is created from a paired single-cell transcriptomic and epigenomic data. |
|
|
10 |
It takes a list of two digital data matrices as input. Genes/loci should be in rows and cells in columns. rownames and colnames should be included. |
|
|
11 |
The class provides functions for data preprocessing, integrative analysis, and visualization. |
|
|
12 |
} |
|
|
13 |
\details{ |
|
|
14 |
The key slots used in the scAI object are described below. |
|
|
15 |
} |
|
|
16 |
\section{Slots}{ |
|
|
17 |
|
|
|
18 |
\describe{ |
|
|
19 |
\item{\code{raw.data}}{List of raw data matrices, one per dataset (Genes/loci should be in rows and cells in columns)} |
|
|
20 |
|
|
|
21 |
\item{\code{norm.data}}{List of normalized matrices (genes/loci by cells)} |
|
|
22 |
|
|
|
23 |
\item{\code{agg.data}}{Aggregated epigenomic data within similar cells} |
|
|
24 |
|
|
|
25 |
\item{\code{scale.data}}{List of scaled matrices} |
|
|
26 |
|
|
|
27 |
\item{\code{pData}}{data frame storing the information associated with each cell} |
|
|
28 |
|
|
|
29 |
\item{\code{var.features}}{List of informative features to be used, one giving informative genes and the other giving informative loci} |
|
|
30 |
|
|
|
31 |
\item{\code{fit}}{List of inferred low-rank matrices, including W1, W2, H, Z, R} |
|
|
32 |
|
|
|
33 |
\item{\code{fit.variedK}}{List of inferred low-rank matrices when varying the rank K} |
|
|
34 |
|
|
|
35 |
\item{\code{embed}}{List of the reduced 2D coordinates, one per method, e.g., t-SNE/FIt-SNE/umap} |
|
|
36 |
|
|
|
37 |
\item{\code{identity}}{a factor defining the cell identity} |
|
|
38 |
|
|
|
39 |
\item{\code{cluster}}{List of consensus clustering results} |
|
|
40 |
|
|
|
41 |
\item{\code{options}}{List of parameters used throughout analysis} |
|
|
42 |
}} |
|
|
43 |
|