Skip to main content

AlphaRING v2 (AlphaRING-X)

AlphaRING is a package designed for interpretable, protein structure-based prediction of missense variant deleteriousness.

To predict the deleteriousness of a missense variant, AlphaRING performs the following steps:

  1. Predicts the structure of the wild-type protein using AlphaFold to extract the pLDDT of the substituted wild-type residue.
  2. Converts wild-type structure into a residue interaction network using RING to extract the degree of the substituted wild-type residue.
  3. Uses wild-type structure to calculate the ΔΔG of the substitution using FoldX and extracts it.
  4. Calculates the relative substitution position (RSP) along the protein.
  5. Feeds pLDDT, degree, ΔΔG, and RSP into an in-house XGBoost classifier trained to classify missense variant deleteriousness.
  6. Outputs the probability of deleteriousness and feature SHAP values to explain the prediction mechanistically.

[!NOTE] AlphaRING-X manuscript and benchmarking data/scripts (including for classifier training/calibrating/testing) will be released soon.

Installation

Before installation, ensure you have a Linux machine equipped with a modern NVIDIA GPU and the following:

  1. Full AlphaFold v2 genetic database
  2. RING v4
  3. FoldX v5.1
  4. Miniconda

To install AlphaRING, please do the following:

  1. Create an environment for AlphaRING using Miniconda:

    conda create -n alpharing -c bioconda -c conda-forge python==3.10 hmmer kalign2 pdbfixer hhsuite==3.3.0 openmm==8.0.0
    
  2. Activate the environment and install AlphaRING:

    conda activate alpharing
    pip install alpharing
    

Usage

To predict the deleteriousness of a missense variant, activate the AlphaRING environment and execute the alpharing command as follows:

alpharing \
  --fasta_path=... \
  --substitutions=... \
  --output_dir=... \
  --data_dir=... \
  --ring_exe_path=... \
  --foldx_exe_path=...

Argument breakdown:

  • --fasta_path: path to a FASTA file representing the wild-type protein. See here for an example.
  • --substitutions: list of one or more single-residue substitutions to be individually applied to the wild-type protein. Please represent the substitutions in FoldX format, e.g., WA70Y, where W is the wild-type residue, A is the chain, 70 is the substitution position, and Y is the variant residue. For AlphaRING, the chain should always be A. If multiple substitutions are provided, please separate them with commas only, e.g., WA70Y,WA80F.
  • --output_dir: path to the directory that will store the output.
  • --data_dir: path to the directory of the full AlphaFold database.
  • --ring_exe_path: path to the RING executable. This should remain in the original installation.
  • --foldx_exe_path: path to the FoldX executable. This should remain in the original installation.

Downstream

AlphaRING stores the output in a subdirectory within the directory specified by --output_dir. The subdirectory is named after the basename of the FASTA file specified by --fasta_path. In addition to the default AlphaFold, RING, and FoldX outputs, the subdirectory contains the file alpharing_scores.txt, which summarises the feature values, deleteriousness probability, and feature SHAP values of each substitution specified by --substitutions.

[!NOTE] For efficiency, when running a prediction, AlphaRING will check if the FASTA file specified by --fasta_path already has its corresponding output subdirectory with an AlphaFold relaxed model file, and, if found, will skip running AlphaFold.

Release files for alpharing 2.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for alpharing 2.0.0
File Size Uploaded
alpharing-2.0.0.tar.gz 273.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for alpharing 2.0.0
File Interpreter ABI Platform
alpharing-2.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 602.2 kB

Release files / alpharing-2.0.0.tar.gz

Download URL alpharing-2.0.0.tar.gz
Size 273.1 kB
Tags Source
SHA-256 checksum
How to use checksums
abdbaa0c9d3d556697d63443f86072dbdb22a374f022147fb6f9b27bad42381d
BLAKE2b-256 checksum
How to use checksums
d0c5f1b051b8120f079ff00b01c546cc89ff1ea0bbba31925f575e265d9ddae9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.7

Release files / alpharing-2.0.0-py3-none-any.whl

Download URL alpharing-2.0.0-py3-none-any.whl
Size 329.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
143fc6c26320350f8b61fcc45b38e23e4eeb51f8d8ed86f37fe74d28b86981e4
BLAKE2b-256 checksum
How to use checksums
49038c2b6498f7c5465b1042026f4657fd2b6e045f00591e26bfb17a52e5ffe3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.7

Release history Release notifications | RSS feed

This release

2.0.0 This release

2 release files

1.1.0

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page