GetDistance: Get distance data from seurat object

Description Usage Arguments Details Value

View source: R/distance.R

Description

Simple getter method to extract data frame of distances in seurat object.

Usage

1
2
GetDistance(seurat_object, group = NULL, split_by = NULL,
  method = "default")

Arguments

seurat_object

A seurat object. Contains the distance data.

group

Category that the distances were calculated between

split_by

Factor that the distances were split by

method

The distance function that was used. Options are "default" or "cluster" (GroupDistance()), "average" (AverageDistance()), "total" (TotalDistance), "internal" (InternalDistance)

Details

This does not calcualte the distances for any categories or cells. This is purely for indexing information from an object.

Value

Distance data frame.


sbrn3/disscat documentation built on Dec. 12, 2019, 7:54 a.m.