Skip to content

Commit 126a065

Browse files
committed
move tutorials to documentation/, update rescoring tutorial and README
Move misc/tutorials/ to documentation/ and add index readme. Update rescoring.md: add quick-start examples, paper links for all methods, add Pocketeer to supported methods list. Fix stale links in README.md (tutorials path, local-env.sh typo).
1 parent 7634c57 commit 126a065

17 files changed

+51
-14
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -147,15 +147,17 @@ parameters see [Params.groovy](https://github.com/rdk/p2rank/blob/develop/src/ma
147147
### Rescoring (PRANK algorithm)
148148

149149
In addition to predicting new ligand binding sites,
150-
P2Rank is also able to rescore pockets predicted by other methods
151-
(Fpocket,
152-
ConCavity,
153-
SiteHound,
154-
MetaPocket2,
155-
LISE,
150+
P2Rank is also able to rescore pockets predicted by other methods
151+
(Fpocket,
152+
Pocketeer,
153+
ConCavity,
154+
SiteHound,
155+
MetaPocket2,
156+
LISE,
156157
DeepSite,
157158
and PUResNetV2.0
158159
are supported at the moment).
160+
See [rescoring documentation](documentation/rescoring.md) for details.
159161

160162
Rescoring output:
161163
* `{protein_file}_rescored.csv`: list of pockets sorted by the new score
@@ -219,7 +221,7 @@ You can now run the program using:
219221
distro/prank # standard mode that is run in production
220222
./prank.sh # development/training mode
221223
```
222-
To use `./prank.sh` (development/training mode) first you need to copy and edit `misc/locval-env.sh` into repo root directory (see [training tutorial](https://github.com/rdk/p2rank/blob/develop/misc/tutorials/training-tutorial.md#preparing-the-environment)).
224+
To use `./prank.sh` (development/training mode) first you need to copy and edit `misc/local-env.sh` into repo root directory (see [training tutorial](https://github.com/rdk/p2rank/blob/develop/documentation/training-tutorial.md#preparing-the-environment)).
223225

224226
## ⚖️ Comparison with Fpocket
225227

File renamed without changes.

misc/tutorials/dev/ions/balancing-01-ploop-1_DCA_4_0.png renamed to documentation/dev/ions/balancing-01-ploop-1_DCA_4_0.png

File renamed without changes.

misc/tutorials/dev/ions/ions-prediction-method-development-log.md renamed to documentation/dev/ions/ions-prediction-method-development-log.md

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

misc/tutorials/hyperparameter-optimization-tutorial.md renamed to documentation/hyperparameter-optimization-tutorial.md

File renamed without changes.
File renamed without changes.

misc/tutorials/img/feature-tutorial/DCA_4_0_default.png renamed to documentation/img/feature-tutorial/DCA_4_0_default.png

File renamed without changes.

0 commit comments

Comments
 (0)