Update README.md
Browse files
README.md
CHANGED
|
@@ -14,15 +14,15 @@ This repository contains the code accompanying our pre-print (link coming soon).
|
|
| 14 |
## Installation
|
| 15 |
|
| 16 |
```bash
|
| 17 |
-
pip install git+https://github.com/PickyBinders/tea.git
|
| 18 |
```
|
| 19 |
|
| 20 |
## Sequence Conversion with TEA
|
| 21 |
|
| 22 |
-
The `tea_convert` command takes protein sequences from a FASTA file and generates new tea-FASTA. It supports confidence-based sequence output where low-confidence positions are displayed in lowercase, and has options for saving logits and entropy. If `--save_avg_entropy` is set, the FASTA identifiers will contain the average entropy of the sequence in the format `<key>|
|
| 23 |
|
| 24 |
```bash
|
| 25 |
-
usage: tea_convert [-h] -f FASTA_FILE -o OUTPUT_FILE [-
|
| 26 |
|
| 27 |
options:
|
| 28 |
-h, --help show this help message and exit
|
|
@@ -30,12 +30,12 @@ options:
|
|
| 30 |
Input FASTA file containing protein amino acid sequences
|
| 31 |
-o OUTPUT_FILE, --output_file OUTPUT_FILE
|
| 32 |
Output FASTA file for generated tea sequences
|
| 33 |
-
-
|
| 34 |
-
-
|
| 35 |
Save average entropy values in FASTA identifiers
|
| 36 |
-r, --save_residue_entropy
|
| 37 |
Save per-residue entropy values to .pt file
|
| 38 |
-
-
|
| 39 |
Save residues with entropy > threshold in lowercase
|
| 40 |
-t ENTROPY_THRESHOLD, --entropy_threshold ENTROPY_THRESHOLD
|
| 41 |
Entropy threshold for lowercase conversion
|
|
|
|
| 14 |
## Installation
|
| 15 |
|
| 16 |
```bash
|
| 17 |
+
python -m pip install git+https://github.com/PickyBinders/tea.git
|
| 18 |
```
|
| 19 |
|
| 20 |
## Sequence Conversion with TEA
|
| 21 |
|
| 22 |
+
The `tea_convert` command takes protein sequences from a FASTA file and generates new tea-FASTA. It supports confidence-based sequence output where low-confidence positions are displayed in lowercase, and has options for saving logits and entropy. If `--save_avg_entropy` is set, the FASTA identifiers will contain the average entropy of the sequence in the format `<key>|H=<avg_entropy>`.
|
| 23 |
|
| 24 |
```bash
|
| 25 |
+
usage: tea_convert [-h] -f FASTA_FILE -o OUTPUT_FILE [-l] [-H] [-r] [-c] [-t ENTROPY_THRESHOLD]
|
| 26 |
|
| 27 |
options:
|
| 28 |
-h, --help show this help message and exit
|
|
|
|
| 30 |
Input FASTA file containing protein amino acid sequences
|
| 31 |
-o OUTPUT_FILE, --output_file OUTPUT_FILE
|
| 32 |
Output FASTA file for generated tea sequences
|
| 33 |
+
-l, --save_logits Save per-residue logits to .pt file
|
| 34 |
+
-H, --save_avg_entropy
|
| 35 |
Save average entropy values in FASTA identifiers
|
| 36 |
-r, --save_residue_entropy
|
| 37 |
Save per-residue entropy values to .pt file
|
| 38 |
+
-c, --lowercase_entropy
|
| 39 |
Save residues with entropy > threshold in lowercase
|
| 40 |
-t ENTROPY_THRESHOLD, --entropy_threshold ENTROPY_THRESHOLD
|
| 41 |
Entropy threshold for lowercase conversion
|