ChimeraX Projections
Creates ChimeraX compatible scripts to visualise user generated results on a 3D model of the protein.
4 Functions available for the end user:
-
project_chimerax_per_res_scores(per_res_scores, model_name, out_dir) Write out a ChimeraX compatible script to project the per residue scores.
-
project_multiple_per_res_scores(all_per_res_scores, out_dir) Write out multiple ChimeraX compatible visualisation scripts for the per residue scores, one script for each model used.
-
project_chimerax_top_features() Write out a ChimeraX compatible script to project the top features.
-
project_multiple_per_feature_scores(all_feature_scores, numb_features, out_dir) Write out multiple ChimeraX compatible scripts for different models.
get_residue_coordinates(pdb_file, residue_number)
Get the coordinates of the CA atom of a specified residue from a PDB file.
Parameters
pdb_file : str Path to the PDB file. residue_number : int The residue number.
Returns
Tuple[float, float, float] The x, y, z coordinates of the CA atom.
Source code in key_interactions_finder/chimerax_projections.py
project_chimerax_per_res_scores(per_res_scores, model_name='', out_dir='', sphere_color='red')
Write out a ChimeraX compatible script to project the per residue scores.
Parameters
dict
The keys are each residue and values the per residue score.
str
Appended to start of output file to identify it.
str
Folder to save outputs to, if none given, saved to current directory.
str
Color of spheres created per residue.
Source code in key_interactions_finder/chimerax_projections.py
project_chimerax_top_features(per_feature_scores, model_name, pdb_file, numb_features='all', out_dir='')
Write out a ChimeraX compatible script to project the top X features. Features will be shown as cylinders between each residue pair, with cylinder size controlled according to relative score and cylinder colour controlled by interaction type.
Parameters
dict
Keys are the names of the features and values are their scores.
str
What name to appended to the start of the output file name to help identify it.
str
Path to the PDB file.
int or str
The max number of top scoring features to determine (specified by an int). Alternatively, if set to "all", then all feature scores will be determined.
str
Folder to save outputs to, if none given, saved to current directory.
Source code in key_interactions_finder/chimerax_projections.py
project_multiple_per_feature_scores(all_per_feature_scores, pdb_file, numb_features, out_dir='')
Write out multiple ChimeraX compatible scripts for different models.
Parameters
dict
Nested dictionary, the outer layer keys are the model names/methods used. The inner layer is a dict with keys being each residue and values the per residue score.
str
Path to the PDB file.
int or str
The max number of top scoring features to determine (specified by an int). Alternatively, if set to "all", then all per feature scores will be determined.
str
Folder to save outputs to, if none given, saved to current directory.
Source code in key_interactions_finder/chimerax_projections.py
project_multiple_per_res_scores(all_per_res_scores, out_dir='')
Write out multiple ChimeraX compatible visualisation scripts for the per residue scores, one script for each model used.
Parameters
dict
Nested dictionary, the outer layer keys are the model names/methods used. The inner layer is a dict with keys being each residue and values the per residue score.
str
Folder to save outputs to, if none given, saved to current directory.