Skip to content

Commit cf26aa9

Browse files
committed
update readme
1 parent 6bbf530 commit cf26aa9

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@ prank predict -c alphafold test.ds # use alphafold config and model (confi
111111
mapping to predicted pockets, and a calibrated probability of being a ligand-binding residue
112112
* PyMol and ChimeraX visualizations in `visualizations/` directory (`.pml` and `.cxc` scripts with data files in `data/`)
113113
* generating visualizations can be turned off by `-visualizations 0` parameter
114-
* coordinates of the SAS points can be found in `visualizations/data/<struct_file>_points.pdb.gz`. There the "Residue sequence number" (23-26 of HETATM record)
114+
* `-vis_renderers 'pymol,chimerax'` parameter can be used to turn individual visualization renderers on/off
115+
* coordinates of SAS points can be found in `visualizations/data/<struct_file>_points.pdb.gz`. There the "Residue sequence number" (23-26 of HETATM record)
115116
corresponds to the rank of the corresponding pocket (points with value 0 don't belong to any pocket)
116117
* `-vis_copy_proteins 0` parameter can be used to turn off copying of protein structures to the visualizations directory (faster but visualizations won't be portable)
117118

@@ -163,20 +164,22 @@ are supported at the moment).
163164
Rescoring output:
164165
* `<struct_file>_rescored.csv`: list of pockets sorted by the new score
165166
* `<struct_file>_predictions.csv`: same as with `prank predict` (since 2.5)
167+
* Note: probability column is calibrated for rescoring fpocket predictions
166168
* visualizations
167169

168-
Note: probability column in `predictions.csv` is calibrated for rescoring fpocket predictions.
169-
170170
~~~bash
171171
prank rescore fpocket.ds
172172
prank rescore fpocket.ds -o output_here # explicitly specify output directory
173-
prank rescore fpocket.ds -c rescore_2024 # use a new experimental rescoring model
173+
prank rescore fpocket.ds -c rescore_2024 # use new experimental rescoring model (recommended for alphafold models)
174174

175175
prank eval-rescore fpocket.ds # evaluate rescoring model on a dataset with known ligands
176176
~~~
177177

178178
For rescoring the dataset file needs to have a specific 2-column format. See examples in `test_data/`: `fpocket.ds`, `concavity.ds`, `puresnet.ds`.
179179

180+
New experimental rescoring model `-c rescore_2024` shows promising result but hasn't been fully evaluated yet. It is recommended for AlphaFold models, NMR and cryo-EM structures since it doesn't depend on b-factor as a feature.
181+
182+
180183

181184
#### Run fpocket and rescore in one command
182185

src/main/groovy/cz/siret/prank/program/params/Params.groovy

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -726,6 +726,7 @@ class Params {
726726
/**
727727
* zip PyMol visualizations to save space
728728
*/
729+
@Deprecated
729730
@RuntimeParam
730731
boolean zip_visualizations = false
731732

0 commit comments

Comments
 (0)