histogram_dist: Compute the pairwise Jensen-Shannon distance between samples...

Description Usage Arguments Value

View source: R/metric.R

Description

Computes pairwise set of Jensen-Shannon distance provided a set of histograms. Several histogram groups can be provided having different 'type' value. If specified, will also only compare samples with the same antigen receptor chain

Usage

1
histogram_dist(data, cores, add.pseudocounts, filter.by.chain)

Arguments

data

a set of histograms, should contain 'sample.id', statistic type - 'type', bin identifier - 'variable' and frequency/count - 'value' columns

cores

number of cores for parallelization

add.pseudocounts

if True, will add pseudocounts and re-normalize histograms, in this case 'value' should contain count, not frequency

filter.by.chain

if True, will only compare samples with the same chain, requires additional 'chain' column in 'data'

Value

a pairwise distance table, containing sample ids in 'sample.id.1' and 'sample.id.2' columns, statistic type in 'type' column and distance in 'd' column; if 'filter.by.chain' is set to true will also include 'chain' column


milaboratory/mirutil documentation built on May 20, 2019, 1:24 p.m.