Man pages for immunarch
Multi-Modal Immune Repertoire Analytics for Immunotherapy and Vaccine Design in R

aa_propertiesTables with amino acid properties
aa_tableAmino acid / codon table
add_classAdd a new class attribute
airr_clonalityClonality - receptor overabundance statistics for immune...
airr_diversityDiversity - estimating the heterogeneity of immune...
airr_publicPublic indices - pairwise repertoire overlap
airr_statsCompute key immune repertoire statistics
annotate_clonalityAnnotate clonality - per-receptor labels for overabundance
apply_symmApply function to each pair of data frames from a list.
bcrdataBCR dataset
bunch_translateNucleotide to amino acid sequence translation
check_distributionCheck and normalise distributions
codingFilter out coding and non-coding clonotype sequences
dbAnnotateAnnotate clonotypes in immune repertoires using clonotype...
dbLoadLoad clonotype databases such as VDJDB and McPAS into the R...
dot-quant_column_choiceGet a column's name using the input alias
entropyInformation measures
fixVisManipulate ggplot plots and create publication-ready plots
gene_segmentsGene segments table
gene_statsWIP
geneUsageMain function for estimation of V-gene and J-gene statistics
geneUsageAnalysisPost-analysis of V-gene and J-gene statistics: PCA,...
get_immunarch_newsGet the Latest immunarch Update
getKmersCalculate the k-mer statistics of immune repertoires
group_from_metadataGet a character vector of samples' groups from the input...
has_classCheck for the specific class
im_common_argsCommon arguments for immunarch helpers
immdataSingle chain immune repertoire dataset
immunarch_v1_updatesGet a list of package updates
immunr_data_formatSpecification of the data format used by immunarch dataframes
immunr_hclustClustering of objects or distance matrices
immunr_pcaDimensionality reduction
inc_overlapIncremental counting of repertoire similarity
list_immunarch_newsList Available immunarch Updates
matrixdiagcopyCopy the upper matrix triangle to the lower one
public_matrixGet a matrix with public clonotype frequencies
pubRepCreate a repertoire of public clonotypes
pubRepApplyApply transformations to public repertoires
pubRepFilterFilter out clonotypes from public repertoires
pubRepStatisticsStatistics of number of public clonotypes for each possible...
register_immunarch_methodRegister an Immunarch method (developer)
repAlignLineageAligns all sequences incliding germline within each clonal...
repClonalFamilyBuilds a phylogenetic tree using the sequences of a clonal...
repClonalityClonality analysis of immune repertoires
repDiversityThe main function for immune repertoire diversity estimation
repExploreMain function for exploratory data analysis: compute the...
repFilterMain function for data filtering
repGermlineCreates germlines for clonal lineages
repLoadLoad immune repertoire files into the R workspace
repOverlapMain function for public clonotype statistics calculations
repOverlapAnalysisPost-analysis of public clonotype statistics: PCA,...
repSampleDownsampling and resampling of immune repertoires
repSaveSave immune repertoires to the disk
repSomaticHypermutationCalculates number of mutations against the germline for each...
select_barcodesSelect specific clonotypes using barcodes from single-cell...
select_clustersSplit the immune repertoire data to clusters from single-cell...
seqClusterFunction for assigning clusters based on sequences similarity
seqDistFunction for computing distance for sequences
set_pbSet and update progress bars
spectratypeImmune repertoire spectratyping
split_to_kmersAnalysis immune repertoire kmer statistics: sequence...
switch_typeReturn a column's name
topGet the N most abundant clonotypes
trackClonotypesTrack clonotypes across time and data points
visOne function to visualise them all
vis_barBar plots
vis_boxFlexible box-plots for visualisation of distributions
vis_circosVisualisation of matrices using circos plots
vis.clonal_familyVisualise clonal family tree: wrapper for calling on the...
vis.clonal_family_treeVisualise clonal family tree
vis_heatmapVisualisation of matrices and data frames using ggplo2-based...
vis_heatmap2Visualisation of matrices using pheatmap-based heatmaps
vis_histVisualisation of distributions using histograms
vis.immunr_chao1Visualise diversity.
vis.immunr_clonal_propVisualise results of the clonality analysis
vis.immunr_dynamicsVisualise clonotype dynamics
vis.immunr_exp_volVisualise results of the exploratory analysis
vis.immunr_gene_usageHistograms and boxplots (general case / gene usage)
vis.immunr_hclustVisualisation of hierarchical clustering
vis.immunr_inc_overlapVisualise incremental overlaps
vis.immunr_kmeansVisualisation of K-means and DBSCAN clustering
vis_immunr_kmer_profile_mainVisualise kmer profiles
vis.immunr_kmer_tableMost frequent kmers visualisation.
vis.immunr_mdsPCA / MDS / tSNE visualisation (mainly overlap / gene usage)
vis.immunr_ov_matrixRepertoire overlap and gene usage visualisations
vis.immunr_public_repertoirePublic repertoire visualisation
vis.immunr_public_statisticsVisualise sharing of clonotypes among samples
vis_public_clonotypesVisualisation of public clonotypes
vis_public_frequenciesPublic repertoire visualisation
vis.step_failure_ignoredHandler for .nofail argument of pipeline steps that prevents...
vis_textlogoSequence logo plots for amino acid profiles.
immunarch documentation built on Nov. 5, 2025, 7:21 p.m.