AbSolution
AbSolution
AbSolutionAbSolutionAbSolution is an interactive tool for exploring immune
repertoires and their sequence-based features. AbSolution
has been designed under the principles of accessibility, scalability,
flexibility, interactivity and reproducibility to be approachable to all
users while customizable for the different AIRR-Seq studies.
This vignette offers an overview of AbSolution’s
functionality, guides you on how to initialize the app with your own
data, and how to customize the app.
AbSolutionThis is easy. Only two lines are required.
Make sure you have space in your hard-drive! It can very easily occupy quite a lot of gigabytes.
Need customized information about your current step?
Check the Help subtab in the AbSolution
tab.
Looking for an in-depth explanation of an option? Activate tooltip mode by clicking the “?” at the top right corner to see explanations for each option when you hover over them.
In the 0.Project information tab, we will define the type of project, samples, and workspace to be used. You need to indicate:
You can try AbSolution with a test
dataset. This is a small, down-sampled dataset of 10x
Genomics Ig V(D)J sequences from CD19+ B cells isolated from the PBMCs
of a healthy human donor. The data, provided by 10x Genomics under a
Creative Commons Attribution license, has been processed using their
Cell Ranger pipeline. It comes from the Alakazam package.
Just click the Instead, load a test dataset button and continue the workflow.
In the 1.AIRR-Seq conversion tab, we will reconstruct the
repertoire germlines based on your input. AbSolution works
with full Fab sequences or sequences with partially-sequenced FWR1/4.
You need to indicate:
Please confirm with the pre-visualization that the sequences are correctly parsed and reconstructed. A lowercase letter in the repertoire sequence indicates an insertion, while a lowercase letter in the reconstructed germline indicates a deletion in the repertoire.
In the 2.Sequence feature determination tab, we will calculate the features (physicochemical, composition, etc.) at the nucleotide (NT) and amino acid (AA) levels for the entire sequence (repertoire and reconstructed germline) and its individual regions.
Just click the button, and wait until it is completed. It can take quite some time depending on your dataset size!
For pre-calculated data, in step 0 you can select to skip steps 1 and 2. In the 1&2.Select your FBM and associated files tab, you can load the files and proceed directly to step 3.
You need to specify the folder where your pre-calculated FBM files are located. All files must be in the same folder, and filenames should match those indicated in the previous step. If the files are found in the folder, it will display ‘Yes’ in the Found_in_folder column; otherwise, it will display ‘No’.
You can also generate dummy datasets with the same number of mutations to use as a negative reference in the next steps.
In the 3.Dataset exploration and variable selection tab, you can customize your analysis by selecting specific sequences, variables, and groups, ensuring a tailored and comprehensive exploration of your dataset. Variables with NAs, infinite values, or zero variance are automatically removed.
There are different steps and options inside:
In the 4.Feature exploration tab, you can plot the filtered variables as a violin plot to observe their behavior according to the selected group in field 4 of the Dataset Exploration and Variable Selection tab. You can add the values as dots, select those of interest, and include the reconstructed germline sequences (if they are not already included) to compare how these values have changed since the germline sequence.
In the 5.Clonal exploration tab, we will define the clonal definition to be used. You can:
If you have a clonal definition assigned and the images in the clonal and feature tabs have loaded, you will be able to export results in the Export Results tab.
AbSolutionIn the Export results tab, after running a full analysis with the app (this means you need to have generated clonal figures in Step 5), you can download a .zip file that follows the ENCORE structure. This .zip file contains the following subfolders:
AbSolution package in the version used for the analysis, a
Docker file, and the renv information to reproduce everything.AbSolution (sequence and feature
information). These files are used for analysis and data
exploration.parse_input and
feature_calculation are not evaluated unless the user sets
eval=TRUE, as they are used to produce the Processed files.
For time efficiency, this part is skipped when producing the .zip. There
are various fields along the pipeline where users can take notes. These
notes will be included in the subsequent notebook and results.AbSolution. The HTML file
includes all the system information and package versioning details.It can take some time to load and some time to generate this .zip file. Be patient!