clonality: clonality

Description Usage Arguments Value Author(s)

Description

Computes the clonality (normalized Shannon Entropy) of vector or all samples in a tcr object

Usage

1
clonality(x, entropy = FALSE, ...)

Arguments

x

A numeric vector or tcr object

entropy

Logical indicating if output should be Entropy (TRUE) or clonality (FALSE), given by 1 - Entropy.

merge

If x is a tcr object, the output will be a tcr object with the clonality merged into the metadata.

Value

If x is a vector, the function returns the clonality. If x is a tcr object, and merge=T, then the function returns a tcr object with clonality included in the metadata for all samples.

Author(s)

Alexander Hopkins


ahopki14/tcrSeqR documentation built on May 16, 2019, 6:56 p.m.