Af-analysis

Af-analysis: a Python package for Alphafold analysis - Published in JOSS (2025)

https://github.com/samuelmurail/af_analysis

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 40 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: biorxiv.org, nature.com, joss.theoj.org, zenodo.org
  • Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Biology Life Sciences - 40% confidence
Last synced: 4 months ago · JSON representation ·

Repository

Analysis of alphafold and colabfold results

Basic Info
  • Host: GitHub
  • Owner: samuelmurail
  • License: gpl-2.0
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 51.2 MB
Statistics
  • Stars: 31
  • Watchers: 2
  • Forks: 6
  • Open Issues: 3
  • Releases: 1
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

Documentation Status codecov Build Status PyPI - Version Downloads status License: GPL v2 Google Colab DOI

About Alphafold Analysis

AF Analysis Logo

af-analysis is a python package for the analysis of AlphaFold protein structure predictions. This package is designed to simplify and streamline the process of working with protein structures generated by:

Source code repository: https://github.com/samuelmurail/af_analysis

Statement of Need

AlphaFold 2 and its derivatives have revolutionized protein structure prediction, achieving remarkable accuracy. Analyzing the abundance of resulting structural models can be challenging and time-consuming. Existing tools often require separate scripts for calculating various quality metrics (pDockQ, pDockQ2, LIS score) and assessing model diversity. af-analysis addresses these challenges by providing a unified and user-friendly framework for in-depth analysis of AlphaFold 2 results.

Main features

  • Import AlphaFold or ColabFold prediction directories as pandas DataFrames for efficient data handling.
  • Calculate and add additional structural quality metrics to the DataFrame, including:
    • pDockQ
    • pDockQ2
    • LIS score
  • Visualize predicted protein models.
  • Cluster generated models to identify diverse conformations.
  • Select the best models based on defined criteria.
  • Add your custom metrics to the DataFrame for further analysis.

Installation

  • af-analysis is available on PyPI and can be installed using pip:

bash pip install af_analysis

  • You can install last version from the github repo:

bash pip install git+https://github.com/samuelmurail/af_analysis.git@main

  • AF-Analysis can also be installed easily through github:

bash git clone https://github.com/samuelmurail/af_analysis cd af_analysis pip install .

Documentation

The complete documentation is available at ReadTheDocs.

  • A notebook showing the basic usage of the af_analysis library can be found here.

  • Alternatively you can test is directly on Google colab:

    Google Colab

Usage

Importing data

Create the Data object, giving the path of the directory containing the results of the alphafold2/colabfold run.

python import af_analysis my_data = af_analysis.Data('MY_AF_RESULTS_DIR')

Extracted data are available in the df attribute of the Data object.

python my_data.df

Analysis

  • The analysis package contains several function to add metrics like pdockQ and pdockQ2:

python from af_analysis import analysis analysis.pdockq(my_data) analysis.pdockq2(my_data)

Docking Analysis

  • The docking package contains several function to add metrics like LIS Score:

python from af_analysis import docking docking.LIS_pep(my_data)

Plots

  • At first approach the user can visualize the pLDDT, PAE matrix and the model scores. The show_info() function displays the scores of the models, as well as the pLDDT plot and PAE matrix in a interactive way.

Interactive Visualization

  • plot msa, plddt and PAE:

python my_data.plot_msa() my_data.plot_plddt([0,1]) best_model_index = my_data.df['ranking_confidence'].idxmax() my_data.plot_pae(best_model_index)

  • show 3D structure (nglview package required):

python my_data.show_3d(my_data.df['ranking_confidence'].idxmax())

Dependencies

af_analysis requires the following dependencies:

  • pdb_numpy
  • pandas
  • numpy
  • tqdm
  • seaborn
  • cmcrameri
  • nglview
  • ipywidgets
  • mdanalysis

Contributing

af-analysis is an open-source project and contributions are welcome. If you find a bug or have a feature request, please open an issue on the GitHub repository at https://github.com/samuelmurail/af_analysis. If you would like to contribute code, please fork the repository and submit a pull request.

Authors

See also the list of contributors who participated in this project.

Citing this work

If you use the code of this package, please cite:

  • Reguei A and Murail S. Af-analysis: a Python package for Alphafold analysis.
    Journal of Open Source Software (2025) doi: 10.21105/joss.07577

bibtex @Article{reguei_af-analysis_2025, title = {Af-analysis: a {Python} package for {Alphafold} analysis}, volume = {10}, issn = {2475-9066}, shorttitle = {Af-analysis}, url = {https://joss.theoj.org/papers/10.21105/joss.07577}, doi = {10.21105/joss.07577}, language = {en}, number = {107}, urldate = {2025-03-14}, journal = {Journal of Open Source Software}, author = {Reguei, Alaa and Murail, Samuel}, month = mar, year = {2025}, pages = {7577}, }

License

This project is licensed under the GNU General Public License version 2 - see the LICENSE file for details.

References

Owner

  • Name: Samuel Murail
  • Login: samuelmurail
  • Kind: user
  • Location: Paris
  • Company: Université de Paris

Assistant Professor of bioinformatics

JOSS Publication

Af-analysis: a Python package for Alphafold analysis
Published
March 14, 2025
Volume 10, Issue 107, Page 7577
Authors
Alaa Reguei ORCID
Université Paris Cité, Inserm, CNRS, BFA, F-75013 Paris, France
Samuel Murail ORCID
Université Paris Cité, Inserm, CNRS, BFA, F-75013 Paris, France, Ressource Parisienne en Bioinformatique Structurale (RPBS), F-75013 Paris, France
Editor
Sarath Menon ORCID
Tags
Alphafold Protein Structure Structural bioinformatics

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Reguei
  given-names: Alaa
  orcid: "https://orcid.org/0009-0006-1718-4864"
- family-names: Murail
  given-names: Samuel
  orcid: "https://orcid.org/0000-0002-3842-5333"
contact:
- family-names: Murail
  given-names: Samuel
  orcid: "https://orcid.org/0000-0002-3842-5333"
doi: 10.5281/zenodo.14859764
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Reguei
    given-names: Alaa
    orcid: "https://orcid.org/0009-0006-1718-4864"
  - family-names: Murail
    given-names: Samuel
    orcid: "https://orcid.org/0000-0002-3842-5333"
  date-published: 2025-03-14
  doi: 10.21105/joss.07577
  issn: 2475-9066
  issue: 107
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 7577
  title: "Af-analysis: a Python package for Alphafold analysis"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.07577"
  volume: 10
title: "Af-analysis: a Python package for Alphafold analysis"

GitHub Events

Total
  • Create event: 3
  • Issues event: 5
  • Release event: 2
  • Watch event: 16
  • Issue comment event: 9
  • Push event: 53
  • Fork event: 3
Last Year
  • Create event: 3
  • Issues event: 5
  • Release event: 2
  • Watch event: 16
  • Issue comment event: 9
  • Push event: 53
  • Fork event: 3

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 200
  • Total Committers: 2
  • Avg Commits per committer: 100.0
  • Development Distribution Score (DDS): 0.01
Past Year
  • Commits: 95
  • Committers: 1
  • Avg Commits per committer: 95.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
samuelmurail s****l@u****r 198
Alaa REGUEI 1****a 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 6
  • Total pull requests: 2
  • Average time to close issues: 20 days
  • Average time to close pull requests: 1 day
  • Total issue authors: 4
  • Total pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 0
  • Average time to close issues: about 3 hours
  • Average time to close pull requests: N/A
  • Issue authors: 4
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • tubiana (3)
  • KuangHu (1)
  • BuseSahin1 (1)
  • srmnitc (1)
Pull Request Authors
  • regueiala (2)
Top Labels
Issue Labels
enhancement (1) question (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 77 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 1
pypi.org: af-analysis

`AF analysis` is a python library allowing analysis of Alphafold results.

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 77 Last month
Rankings
Dependent packages count: 10.1%
Average: 33.4%
Dependent repos count: 56.6%
Maintainers (1)
Last synced: 4 months ago