You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-6Lines changed: 21 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,13 +38,13 @@ python pipeline.py \
38
38
-o {OUTPUT}
39
39
```
40
40
41
-
**Blastn databases** and **contig table** are results of the ```prep_db.sh```
41
+
**Blastn databases** and **contig table** are produced by ```prep_db.sh``` (or built automatically when `-tb` / `-fb` point at **directories of FASTA files**). After each automatic build, the contig table is **deduplicated by contig ID** (duplicate rows from merged FASTAs or repeated runs keep the last mapping).
42
42
43
43
#### Key arguments:
44
-
-`-i INPUT`: Input FASTA file (or directory with fasta / fasta.gz file) for the initial probe setgeneration.
45
-
-`-tb TRUE_BASE`: Input BLASTn database path for primer adjusting.
46
-
-`-fb FALSE_BASE`: Input BLASTn database path for non-specific testing.
47
-
-`-c CONTIG_TABLE`: .tsv table with BLAST database information.
44
+
-`-i INPUT`: Input FASTA file (or directory with fasta / fasta.gz file) for the initial probe set generation.
45
+
-`-tb TRUE_BASE`: BLASTn database path *or* directory of FASTA files for primer adjusting (directories are converted under `{OUTPUT}/.blast_db/`).
46
+
-`-fb FALSE_BASE`: BLASTn database path(s) *or* FASTA directories for non-specific testing.
47
+
-`-c CONTIG_TABLE`: .tsv table with BLAST database information (optional; defaults to `{OUTPUT}/contigs.tsv` when using FASTA directories).
48
48
-`-o OUTPUT`: Output path for results.
49
49
-`-t THREADS`: Number of threads to use.
50
50
-`-a ALGORITHM`: Algorithm for probe generation (`FISH` or `primer`).
@@ -63,10 +63,25 @@ python test_parameters.py \
63
63
-p {JSON}
64
64
```
65
65
66
+
Example usage:
67
+
```bash
68
+
python pipeline.py \
69
+
-i data/test/general/test.fna \
70
+
-o data/test/general/output \
71
+
-tb data/test/general/fasta_base/true_base \
72
+
-fb data/test/general/fasta_base/false_base_1 \
73
+
data/test/general/fasta_base/false_base_2 \
74
+
-a FISH \
75
+
--PRIMER_PICK_PRIMER 5 \
76
+
--PRIMER_NUM_RETURN 5 \
77
+
-N 3 \
78
+
--visualize True --AI True
79
+
```
80
+
66
81
67
82
### Manual preparation
68
83
69
-
`pipeline.py` relies on pre-prepared BLASTn databases. To create the required `true_base`, `false_base`, and `contig_table`, you can use the following script:
84
+
You can pre-build BLASTn databases yourself (e.g. when inputs are already `makeblastdb` outputs). To create `true_base`, `false_base`, and `contig_table` from FASTA files, use:
0 commit comments