Learn R Programming

PIgLET - Program for Ig clusters R package

PIgLET is a suite of computational tools that improves genotype inference and downstream AIRR-seq data analysis. The package as two main tools. The first is Allele Clusters, this tool is designed to reduce the ambiguity within the IGHV alleles. The ambiguity is caused by duplicated or similar alleles which are shared among different genes. The second tool is an allele based genotype, that determined the presence of an allele based on a threshold derived from a naive population.

Core Abilities

Allele Similarity Cluster provides the functions that support the main tool of creating the allele similarity cluster form an IGHV germline set. Allele based genotype provides the functions to infer the IGHV genotype using the allele based method and the allele clusters thresholds.

Required Input

For the allele similarity cluster, a reference set of IUIS/IMGT alleles. The sequences should be gapped.

For the genotype inference, an AIRR-seq format data set.

Installation

PIgLET is available for installation either from the development version.

PIgLET repository installation

To build from the source code, first install the build dependencies:

install.packages(c("devtools", "roxygen2", "testthat", "knitr", "rmarkdown", "plotly"))

To install the latest version via devtools:

library(devtools)
install_bitbucket("yaarilab/piglet")

Note, installing from bitbucket does not generate the documentation. To generate them, first clone the repository and then build:

library(devtools)
install_deps()
document()
build()
install()

Contact

For help, questions, or suggestions, please contact:

Copying

RAbHIT is free for use under the CC BY-SA 4.0

Copy Link

Version

Install

install.packages('piglet')

Monthly Downloads

79

Version

1.0.7

License

CC BY 4.0

Maintainer

Ayelet Peres

Last Published

April 9th, 2025

Functions in piglet (1.0.7)

%>%

Pipe operator
extractASCTable

Extracts the allele cluster table from the archive file.
piglet

The Program for Ig clusters (PIgLET) package
insert_gaps2_vec

Insert gaps into an ungapped sequence based on a gapped reference sequence.
recentAlleleClusters

Retrieving allele similarity clusters Zenodo archive
plotAlleleCluster

Plotting the dendrogram of the clusters
zenodoArchive

zenodoArchive
inferGenotypeAllele_asc

Allele similarity cluster based genotype inference Testing function
piglet-package

piglet: Program for Inferring Immunoglobulin Allele Similarity Clusters and Genotypes
HVGERM

Human IGHV germlines
alleleClusterNames

Allele similarity cluster naming scheme
allele_diff_indices

Calculate differences between characters in columns of germs and return their indices as an int vector.
allele_diff_indices_parallel

Calculate SNPs or their count for each germline-input sequence pair with optional parallel execution.
allele_diff_strings

Calculate differences between characters in columns of germs and return them as a string vector.
GermlineCluster-class

Output of inferAlleleClusters
allele_diff_indices_parallel2

Calculate SNPs or their count for each germline-input sequence pair with optional parallel execution.
allele_diff

Alleles nucleotide position difference
inferAlleleClusters

Allele similarity cluster
ighvClust

Allele similarity clustering
assignAlleleClusters

Assign allele similarity clusters
germlineASC

Converts IGHV germline set to ASC germline set.
hv_functionality

Human IGHV germlines functionality description
allele_threshold_table

Allele thresholds table
generateReferenceSet

Generate allele similarity reference set
ighvDistance

Germline set alleles distance
artificialFRW1Germline

FWR1 artificial dataset generator
allele_cluster_table

Allele similarity cluster table
inferGenotypeAllele

Allele based genotype inference