Description Usage Arguments Value Examples
Calculates the distance between VDJ germlines of interest and produces a matrix that can be used for further analysis or viewed using Heatmap/pheatmap/ComplexHeatmap.
1 | VDJheatmap(species, chain, source, inference.method)
|
species |
Specifies desired species. Current species options can be found by running unique(VDJgermlines$species) after loading in data(VDJgermlines). "all_species" will select all available species. Species include ("alpaca","bovine","crab_eating_macaque","dog", "human","mouse","pig","platypus","rabbit",raintrout","rat","rhesus monkey","salmon", "sheep","zebrafish","atlanticcod","catfish","teleostei","goat","dolphin","mamonkey", "camel","runny") |
chain |
Specifies the desired chain. "all_chains" will select all chains. The various chains can be listed by running unique(VDJgermlines$chain).Antibody loci start with IG, TCR starts with TR.NExt comes either heavy, light, alpha, beta etc. Examples include IGHD IGHJ IGHV IGIJ IGIV IGKJ IGKV IGLJ IGLV TRAJ TRAV TRBD TRBJ TRBV TRDD TRDJ TRDV TRGJ TRGV |
source |
Specifies from which source the desired chains should be taken from. Current sources can be found by running unique(VDJgermlines$source) after loading in data(VDJgermlines). IMGT and vgenerepertoire are currently present. |
inference.method |
Specifies the distance metric to be used to calculate distance. Currently includes parameters from stringdist::stringdistmatrix(), such as "lv","jv","hamming","qgram","cosine","Jaccard","lcs", or "soundex". |
Returns a matrix where the entries correspond to the VDJ germlines used the neighbor joining algorithm. Can be viewed by heatmap() in base r, or pheatmap::pheatmap(VDJheatmap).
1 | VDJheatmap(species = "dog",chain = "IGHD",source = "IMGT")
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.