SlingshotDataSet-class {slingshot}R Documentation

Class SlingshotDataSet

Description

This was the original class for storing slingshot results, but we now generally reommend using the PseudotimeOrdering class, instead. Most slingshot functions will still work with SlingshotDataSet objects, but will return PseudotimeOrdering objects, by default. To update old SlingshotDataSet objects, we have provided the as.PseudotimeOrdering conversion function. The only functions that require SlingshotDataSet objects are the plotting functions.

The SlingshotDataSet class holds data relevant for performing lineage inference with the slingshot package, primarily a reduced dimensional representation of the data and a set of cluster labels.

Usage

## S4 method for signature 'SlingshotDataSet'
show(object)

## S4 method for signature 'SlingshotDataSet,ANY'
reducedDim(x)

## S4 method for signature 'SlingshotDataSet'
reducedDims(x)

Arguments

object

a SlingshotDataSet object.

x

a SlingshotDataSet object.

Value

The accessor functions reducedDim, clusterLabels, lineages, adjacency, curves, and slingParams return the corresponding elements of a SlingshotDataSet. The functions slingPseudotime and slingCurveWeights extract useful output elements of a SlingshotDataSet, provided that curves have already been fit with either slingshot or getCurves.

Methods (by generic)

Slots

reducedDim

matrix. An n by p numeric matrix or data frame giving the coordinates of the cells in a reduced dimensionality space.

clusterLabels

matrix or character. An n by K matrix of weights indicating each cell's cluster assignment or a character vector of cluster assignments, which will be converted into a binary matrix.

lineages

list. A list with each element a character vector of cluster names representing a lineage as an ordered set of clusters.

adjacency

matrix. A binary matrix describing the adjacency between clusters induced by the minimum spanning tree.

curves

list. A list of principal_curve objects produced by getCurves.

slingParams

list. Additional parameters used by Slingshot. These may specify how the minimum spanning tree on clusters was constructed:

They may also specify how simultaneous principal curves were constructed (for a complete listing, see getCurves:

See Also

PseudotimeOrdering


[Package slingshot version 2.0.0 Index]