Skip to content

Commit 532661d

Browse files
committed
update readme
1 parent 83d549a commit 532661d

5 files changed

Lines changed: 14 additions & 5 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,4 @@ ITSx_temp_directory__*
4949
!testdata/*.fa
5050
!testdata/*.fna
5151

52+
data/figures/

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,14 @@ This produces `results/sample1.its1.fasta`, `results/sample1.its2.fasta`, and `r
5454

5555
## Install
5656

57+
### Bioconda (recommended)
58+
59+
ITSxRust is available on [Bioconda](https://bioconda.github.io/). This is the easiest way to install, as it also handles the HMMER dependency:
60+
61+
```bash
62+
conda install -c bioconda -c conda-forge itsxrust
63+
```
64+
5765
### Prebuilt binaries
5866

5967
Download the binary for your platform from [GitHub Releases](https://github.com/ayobi/ITSxRust/releases), then:
@@ -90,7 +98,7 @@ ITSxRust calls `nhmmer` to search profile-HMMs against input sequences. Install
9098
conda install -c bioconda hmmer
9199
```
92100

93-
The Docker image includes HMMER, so no separate installation is needed when using the container.
101+
> **Note:** If you installed via Bioconda or Docker, HMMER is already included — no separate installation is needed.
94102
95103
### HMM profiles
96104

@@ -204,7 +212,7 @@ bench/ Benchmarking + simulation harness
204212

205213
## Roadmap
206214

207-
- Bioconda recipe
215+
- ~~Bioconda recipe~~
208216
- In-process HMM bindings (replace nhmmer subprocess)
209217

210218
## License
-388 Bytes
Binary file not shown.
-229 KB
Binary file not shown.

data/figures/fig3_boundary_errors.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def main():
6565
fig, axes = plt.subplots(2, 3, figsize=(12, 6.5),
6666
gridspec_kw={'height_ratios': [1, 1]})
6767
fig.subplots_adjust(hspace=0.35, wspace=0.28, left=0.07, right=0.97,
68-
top=0.92, bottom=0.08)
68+
top=0.88, bottom=0.08)
6969

7070
# ── Row 1: Box plots (capped at 100bp for visibility) ──
7171
CAP = 100
@@ -137,8 +137,8 @@ def main():
137137
if j == 0:
138138
ax.legend(fontsize=7, loc='lower right', framealpha=0.9)
139139

140-
fig.suptitle('Boundary accuracy on simulated ONT reads', fontsize=12,
141-
fontweight='bold', y=0.97)
140+
fig.suptitle('Boundary accuracy on simulated ONT reads', fontsize=14,
141+
fontweight='bold', y=0.98)
142142

143143
plt.savefig(f'{args.outfile}.pdf', dpi=300, bbox_inches='tight')
144144
plt.savefig(f'{args.outfile}.png', dpi=300, bbox_inches='tight')

0 commit comments

Comments
 (0)