sc_GraphBuilderObj {sincell} | R Documentation

## Graph building function for assessment of cell-state hierarchies

### Description

Function to build a connected graph from a cell-to-cell distance matrix that will be regarded as a cell-state hierarchy. Three algorithms are available: the Minimum Spanning Tree (MST), the Maximum Similarity Spanning Tree (SST) and the Iterative Mutual Clustering Graph (IMC). Optionally, algorithms in sc_GraphBuilderObj can use a precalculated clustering of cells. In the case of MST, this is used to overlay connections between pairs of cells belonging to the same cluster. In the case of SST, clusters of cells are treated as atomic elements in the graph-building process together with non-clustered cells. By definition, IMC builds a connected graph through iterations on the clustering results produced the K-Mutual Nearest Neighbour (K-MNN) algorithm.

### Usage

    sc_GraphBuilderObj(SincellObject, graph.algorithm="MST",
      graph.using.cells.clustering=FALSE,k=3)

### Arguments

`SincellObject` | A SincellObject named list as created by function sc_distanceObj() or sc_DimensionalityReductionObj(), containing in member "cell2celldist" a distance matrix representing a cell-to-cell distance matrix assessed on a gene expression matrix with a metric of choice.
`graph.algorithm` | Graph building algorithm to be used: the Minimum Spanning Tree (graph.algorithm="MST"), the Maximum Similarity Spanning Tree (graph.algorithm="SST") and the Iterative Mutual Clustering Graph (graph.algorithm="IMC").
`graph.using.cells.clustering` | If graph.using.cells.clustering=TRUE and graph.algorithm="MST" or graph.algorithm="MST", a precalculated clustering of cells is used. The clustering of cells is taken from SincellObject[["cellsClustering"]] as calculated by function sc_clusterObj().
`k` | If IMC algorithm is selected, the number of nearest neighbors used in the underlying K-Mutual Nearest Neighbour (K-MNN) algorithm is set to k.

### Value

The SincellObject named list provided as input where following list members are added: "cellstateHierarchy"=cellstateHierarchy, "graph.algorithm"=graph.algorithm, "graph.using.cells.clustering"=graph.using.cells.clustering. The member "cellstateHierarchy" contains an igraph graph object (see "igraph" R package documentation) representing a totally connected graph built with the indicated parameters.

### Examples

    ## Generate some data
    ## Generate some random data
    Data <- matrix(abs(rnorm(3000, sd=2)),ncol=10,nrow=300)

    ## Initializing SincellObject named list
    mySincellObject <- sc_InitializingSincellObject(Data)

    ## Assessmet of cell-to-cell distance matrix after dimensionality reduction with
    ## Principal Component Analysis (PCA)
    mySincellObject <- sc_DimensionalityReductionObj(mySincellObject, method="PCA",dim=2)

    ## Cluster
    mySincellObject <- sc_clusterObj (mySincellObject, clust.method="max.distance",
      max.distance=0.5)

    ## Assessment of cell-state hierarchy
    mySincellObject<- sc_GraphBuilderObj(mySincellObject, graph.algorithm="MST",
      graph.using.cells.clustering=FALSE)
    mySincellObject<- sc_GraphBuilderObj(mySincellObject, graph.algorithm="SST",
      graph.using.cells.clustering=TRUE)
    mySincellObject<- sc_GraphBuilderObj(mySincellObject, graph.algorithm="IMC")

    ## To access the totally connected graph (igraph object)
    cellstateHierarchy<-mySincellObject[["cellstateHierarchy"]]

[Package sincell version 1.20.0 Index]