rank_abundance_stat_test: Rank Abundance Statistical Test

Description Usage Arguments Value Examples

View source: R/rank_abundance_stat_test.R

Description

Carries out a specific instance of statistical testing relevant to clonal tracking experiments. For the provided SummarizedExperiment, compare the rank-abundance distribution which is described by the increase in cumulative abundance within that sample as barcode abundances are added, starting with the most abundant barcode. The two-sided Kolmogorov-Smirnov statistical test is carried out comparing each pair of samples using the R function ks.test:https://www.rdocumentation.org/packages/dgof/versions/1.2/topics/ks.test Note that this test compares rank-abundance distribution regardless of whether the samples share the same barcodes or lineage tracing elements. The test could be employed on two samples with no barcode sequence overlap, simply to compare whether the rank abundance distribution of barcodes is drawn from the same distribution.

Usage

1
rank_abundance_stat_test(your_SE, statistical_test = "ks")

Arguments

your_SE

Summarized Experiment object containing clonal tracking data as created by the barcodetrackR 'create_SE' function.

statistical_test

The statistical test used to compare distributions. For now, the only implemented test is the Kolmogorov-Smirnov test.

Value

Returns a list containing two dataframes
[["D_statistic"]] is a dataframe containing pairwise D-statistics between each pair of samples in your_SE. The D statistic represents the maximal difference between the two rank abundance distributions.
[["p_value]] A dataframe containing the p-value computed by the KS test for each pair of samples. The null hypothesis is that the two rank-abundance profiles come from the same distribution.

Examples

1
2
data(wu_subset)
rank_abundance_stat_test(your_SE = wu_subset, statistical_test = "ks")

d93espinoza/barcodetrackR documentation built on April 28, 2021, 1:58 p.m.