rds: rds

View source: R/rds.R

rdsR Documentation

rds

Description

Main function to run RDS calculations on a cancer phylogeny (phylo object). Must use Naxerova Lab Normal/Primary/Metastasis tip label conventions.

Usage

rds(phy, drop_na = T, use_gmp = T)

Arguments

phy

A phylo-class cancer phylogeny

drop_na

Omit rows in the output data.frame with NA RDS values (detault=T)

use_gmp

Use gmp R package to calculate RDS for large trees. Required for trees with more around 30 tips (default=T)

Value

data.frame where rows are metastasis sample-types and columns are k, l, m, and RDS values.


agorelick/rds documentation built on May 31, 2024, 3:35 a.m.