perturbation: perturbation scores computation

Description Usage Arguments Value Examples

Description

function computes the perturbation scores as a distance between each repertoire and the mean repertoire of the control group.

Usage

1
2
3
4
5
6
perturbation(
  x,
  ctrl.names,
  distance = c("manhattan", "euclidean", "canberra", "minkowski", "maximum"),
  p = 2
)

Arguments

x

an object of class RepSeqExperiment.

ctrl.names

a vector of characters indicating the names of samples used as control repertoire.

distance

distance used for perturbation calculus.

p

an integer, the power of Minkowski distance. Default p = 2.

Value

a data frame containing perturbation scores for each V-genes.

Examples

1
2
3
4
5
6
7
8
## Not run: 
## The package RepSeqData contains example datasets 
library(RepSeqData)
rownames(sData(RepSeqData))
pert <- perturbation(RepSeqData, ctrl.names = c("S01", "S02", "S03"), distance = "manhattan")
pert

## End(Not run)

ph-pham/RepSeq documentation built on Dec. 22, 2021, 7:47 a.m.