Skip to content

Commit d95fa27

Browse files
author
Structural Bioinformatics Laboratory
authored
Update README.md
1 parent c7d38a5 commit d95fa27

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,18 @@ This should produce output **`example/out_pssm/GCN4_YEAST.out`** identical to **
3131
```bash
3232
python3.5 deepcoil.py [-h] -i FILE [-out_path DIR] [-pssm] [-pssm_path DIR]
3333
```
34-
| Option            | Description |
34+
| Option | Description |
3535
|:-------------:|-------------|
3636
| **`-i`** | Input file in FASTA format. Can contain multiple entries. |
3737
| **`-pssm`** | Flag for the PSSM-mode. If enabled DeepCoil will require psiblast PSSM files in the pssm_path. Otherwise only sequence information will be used.|
3838
| **`-pssm_path`** | Directory with psiblast PSSM files. For each entry in the input fasta file there must be a PSSM file. |
3939
| **`-out_path`** | Directory where the predictions are saved. For each entry one file will be saved. |
4040
| **`-out_type`** | Output type. Either **'ascii'** (default), which will write single file for each entry in input or **'h5'** which will generate single hdf5 file storing all predictions. |
4141
| **`-out_filename`** | Works with **"-out_type h5"** option and specifies the hdf5 output filename Overrides the **-out_path** if specified. |
42-
| **`-min_residue_score`** | Number from range <0,1>. If passed return sequences which have at least one residue with greater score |
43-
| **`-min_segment_length`** | Number greater than 0. If passed return sequences which have segment of length at least **-min_segment_length** |
42+
| **`-min_residue_score`** | Number in the range <0,1>. DeepCoil will return sequences that have at least one residue with score greater than min_residue_score |
43+
| **`-min_segment_length`** | Number greater than 0. If passed, DeepCoil will return sequences that have a segment of length at least **-min_segment_length**. To be used with **-min_residue_score** |
44+
45+
4446

4547
PSSM filenames should be based on the identifiers in the fasta file (only alphanumeric characters and '_'). For example if a fasta sequence is as follows:
4648
```

0 commit comments

Comments
 (0)