Giter Club home page Giter Club logo

alphafold-analyser's Introduction

AlphaFold Analyser

AlphaFold Analyser is a command line tool to produce high quality visualisations of protein structures predicted by AlphaFold2. These visualisations allow the user to view the pLDDT of each residue of a protein structure and the predicted alignment error for the entire protein to rapidly infer the quality of a predicted structure. Alphafold analyser can process the results of both multimer and monomer predictions.

Dependencies for AlphaFold Analyser can be found in requirements.txt. In addition the following software is also required:

  • Python >=3.7
  • PyMol == 2.5.2

Installing AlphaFold Analyser on Linux & MacOSX

At the command line, change directory to the directory where alphafold-analyser.py was downloaded, , using the full path name.

cd <download-directory>

Now move the file to where you normally keep your binaries. This directory should be in your path. Note: you may require administrative privileges to do this (either switching user to root or by using sudo).

As root:

mv alphafold-analyser.py /usr/local/bin/

As regular user:

sudo mv alphafold-analyser.py /usr/local/bin/

alphafold-analyser.py should now run from the shell or Terminal using the command alphafold-analyser.py

Alternatively, alphafold-analyser.py can be run directly from an IDE.

Using AlphaFold Analyser

Please note: to plot the predicted aligned error of a monomer; AlphaFold must be run using the setting —model_preset=monomer_ptm (ptm models are automatically generated for multimer predictions).

When running alphafold analyser, please ensure the structure and pickle file used are for the same prediction. All commands require an output directory to be specified (-o or —output_directory) and can be run simultaneously.

alphafold-analyser.py --pkl protein.pkl --pdb protein.pdb --binary path/to/pymol/binary --output my_directory

Creating a pLDDT annotated structure

A pLDDT annotated structure can be generated using the following command:

alphafold-analyser.py --pdb protein.pdb --binary path/to/pymol/binary --output my_directory

Generating a predicted alignment error and pLDDT plot

A pae plot can be generated using the following command:

alphafold-analyser.py --pkl protein.pkl --output my_directory

Outputs

outputs

AlphaFold Analyser creates the following outputs:

  1. A plot of pLDDT across the structure (plddt.png).

  2. A PyMol session (pLDDT.pse): This will contain the structure predicted by AlphaFold with each individual residues coloured according to their pLDDT as follows:

    Colour pLDDT confidence
    Blue Very high (pLDDT > 90)
    Cyan High (90 > pLDDT > 70)
    Orange Low (70 > pLDDT > 50)
    Yellow Very low (pLDDT < 50)
  3. A predicted aligned error plot (pae.png). The confidence values for each residue are coloured using the same colour scheme as the PyMol session.

Citing AlphaFold Analyser

If you use this code or tool please cite:

@article {Hafeez2023,
	author = {Hafeez, Amber N. and Chartrain, Laetitia and Feng, Cong and Cambon, Florence and Clarke, Martha and Griffiths, Simon and Hayta, Sadiye and Jiang, Mei and Keller, Beat and Kirby, Rachel and Kolodziej, Markus C. and Powell, Oliver R. and Smedley, Mark and Steuernagel, Burkhard and Xian, Wenfei and Wingen, Luzie U. and Cheng, Shifeng and Saintenac, Cyrille and Wulff, Brande B. H. and Brown, James K. M.},
	title = {Septoria tritici blotch resistance gene Stb15 encodes a lectin receptor-like kinase},
	elocation-id = {2023.09.11.557217},
	year = {2023},
	doi = {10.1101/2023.09.11.557217},
	publisher = {Cold Spring Harbor Laboratory},
	URL = {https://www.biorxiv.org/content/early/2023/09/12/2023.09.11.557217},
	eprint = {https://www.biorxiv.org/content/early/2023/09/12/2023.09.11.557217.full.pdf},
	journal = {bioRxiv}
}

In addition please also cite the AlphaFold papers as necessary.

Feedback

Any and all feedback is welcome, just raise an issue and I'll get back to you!

alphafold-analyser's People

Contributors

orpowell avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.