Skip to content

Commit 64c7cdc

Browse files
authored
Merge pull request #9 from TravisWheelerLab/dev
readme fixes
2 parents 0d16e76 + c3018a5 commit 64c7cdc

File tree

4 files changed

+815
-166
lines changed

4 files changed

+815
-166
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ There are two sub-projects in the nail workspace:
1313
1. `nail`: this is the command line tool
1414
2. `libnail`: this is a Rust library that contains the implementation of nail's sparse alignment algorithms
1515

16+
### Example input files
17+
18+
A few example input files may be found under the `fixtures/` directory at the root of this repository.
19+
20+
$ ls fixtures/
21+
query.fa target.fa query.hmm
22+
1623
## Dependencies
1724

1825
The `nail search` pipeline uses the `mmseqs search` tool as an alignment prefilter.
@@ -54,7 +61,7 @@ The nail command line interface has two subcommands: `search` and `seed`.
5461

5562
The `nail search` command runs the entire nail pipeline, including running MMseqs2 to find alignment seeds.
5663

57-
The input to `nail search` is a query file (.hmm|.fasta) and a target sequence database file (.fasta).
64+
The input to `nail search` is a query file (p7HMM or FASTA) and a target sequence database file (FASTA).
5865

5966
By default, the search results will be written to `./results.tbl` in a tabular format, and alignment output is written to stdout.
6067
In addition, a collection of temporary files required to run `mmseqs search`, will be written to the `./prep/` directory.

0 commit comments

Comments
 (0)