Skip to content

Commit 14a0a55

Browse files
committed
Update usage instructions
1 parent 746f191 commit 14a0a55

File tree

2 files changed

+17
-13
lines changed

2 files changed

+17
-13
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,18 @@ strategies.
8282
optional arguments:
8383
-h, --help show this help message and exit
8484
-mol MOL Input file with descriptors.
85-
-sep SEP Separator for input file.
86-
-clf CLF Classification algorithm type.
87-
-sampling SAMPLING Resampling method type.
85+
-sep SEP Separator for input file. Default="\s+|\t+".
86+
-clf CLF Classification algorithm type. Default=xgb.
87+
-sampling SAMPLING Resampling method type. Default=classic_ADASYN.
8888
-output OUTPUT Name of output file, CSV or XLSX format.
89+
Default=B3clf_output.xlsx.
8990
-verbose VERBOSE If verbose is not zero, B3clf will print out the
90-
predictions.
91+
predictions. Default=1.
9192
-keep_features KEEP_FEATURES
92-
To keep computed feature file or not.
93-
-keep_sdf KEEP_SDF To keep computed molecular geometries or not.
93+
To keep computed feature file ("yes") or not ("no").
94+
Default=no.
95+
-keep_sdf KEEP_SDF To keep computed molecular geometries ("yes") or not
96+
("no"). Default=no.
9497
```
9598

9699
In `Python`, it is also doable with

b3clf/__main__.py

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,31 +45,32 @@ def main():
4545
parser.add_argument("-sep",
4646
type=str,
4747
default="\s+|\t+",
48-
help="Separator for input file.")
48+
help="""Separator for input file. Default="\s+|\\t+".""")
4949
parser.add_argument("-clf",
5050
type=str,
5151
default="xgb",
52-
help="Classification algorithm type.")
52+
help="Classification algorithm type. Default=xgb.")
5353
parser.add_argument("-sampling",
5454
type=str,
5555
default="classic_ADASYN",
56-
help="Resampling method type.")
56+
help="Resampling method type. Default=classic_ADASYN.")
5757
parser.add_argument("-output",
5858
type=str,
5959
default="B3clf_output.xlsx",
60-
help="Name of output file, CSV or XLSX format.")
60+
help="Name of output file, CSV or XLSX format. Default=B3clf_output.xlsx.")
6161
parser.add_argument("-verbose",
6262
type=int,
6363
default=1,
64-
help="If verbose is not zero, B3clf will print out the predictions.")
64+
help="If verbose is not zero, B3clf will print out the predictions. "
65+
"Default=1.")
6566
parser.add_argument("-keep_features",
6667
type=str,
6768
default="no",
68-
help="To keep computed feature file or not.")
69+
help="""To keep computed feature file ("yes") or not ("no"). Default=no.""")
6970
parser.add_argument("-keep_sdf",
7071
type=str,
7172
default="no",
72-
help="To keep computed molecular geometries or not. ")
73+
help="""To keep computed molecular geometries ("yes") or not ("no"). Default=no.""")
7374
args = parser.parse_args()
7475

7576
_ = b3clf(mol_in=args.mol,

0 commit comments

Comments
 (0)