Skip to content

Commit 3d4f586

Browse files
committed
update readme
1 parent 8699232 commit 3d4f586

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,12 +133,17 @@ prank predict -c example.groovy test.ds
133133
~~~
134134

135135

136-
It is also possible to override the default params on the command line using their full name. To see complete list of params look into `config/default.groovy`.
136+
It is also possible to override the default params on the command line using their full name.
137137

138138
~~~bash
139-
prank predict -seed 151 -threads 8 test.ds
140-
prank predict -c example.groovy -seed 151 -threads 8 test.ds
141-
~~~
139+
prank predict -seed 151 -threads 8 test.ds # set random seed and number of threads, override defeults
140+
prank predict -c example.groovy -seed 151 -threads 8 test.ds # override defaults as well as values from example.groovy
141+
~~~
142+
143+
P2Rank has numerous configurable parameters.
144+
To see the list of standard params look into `config/default.groovy` and other example config files in this directory.
145+
To see the complete commented list of all (including undocumented)
146+
params see [Params.groovy](https://github.com/rdk/p2rank/blob/develop/src/main/groovy/cz/siret/prank/program/params/Params.groovy) in the source code.
142147

143148
### Rescoring (PRANK algorithm)
144149

distro/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,12 +133,17 @@ prank predict -c example.groovy test.ds
133133
~~~
134134

135135

136-
It is also possible to override the default params on the command line using their full name. To see complete list of params look into `config/default.groovy`.
136+
It is also possible to override the default params on the command line using their full name.
137137

138138
~~~bash
139-
prank predict -seed 151 -threads 8 test.ds
140-
prank predict -c example.groovy -seed 151 -threads 8 test.ds
141-
~~~
139+
prank predict -seed 151 -threads 8 test.ds # set random seed and number of threads, override defeults
140+
prank predict -c example.groovy -seed 151 -threads 8 test.ds # override defaults as well as values from example.groovy
141+
~~~
142+
143+
P2Rank has numerous configurable parameters.
144+
To see the list of standard params look into `config/default.groovy` and other example config files in this directory.
145+
To see the complete commented list of all (including undocumented)
146+
params see [Params.groovy](https://github.com/rdk/p2rank/blob/develop/src/main/groovy/cz/siret/prank/program/params/Params.groovy) in the source code.
142147

143148
### Rescoring (PRANK algorithm)
144149

0 commit comments

Comments
 (0)