ThomasDOtto / ratt

Rapid Annotation Transfer Tool
GNU General Public License v3.0
8 stars 4 forks source link

Update documentation #11

Closed nataquinones closed 1 year ago

nataquinones commented 1 year ago

I was trying to run ratt as specified in this documentation:

 ratt <Directory with embl-files> <Query-fasta sequence> <Resultname> <Transfer type> <optional: reference (multi) Fasta>

but that causes the following error:

A required option was not passed. See ratt(1) for usage information.

In this version, you need to specify the options -p for <Resultname> and -t for <Transfer type>. It successfully runs like this:

ratt <Directory with embl-files> <Query-fasta sequence> -p <Resultname> -t <Transfer type>
0xaf1f commented 1 year ago

Yeah, consistent documentation would be nice. The current version's usage is described at https://github.com/ThomasDOtto/ratt/blob/master/ratt.1.md

haessar commented 1 year ago

Closing with https://github.com/ThomasDOtto/ratt/commit/2edce3351951c21e46f2765e77b6b9285937714f Please reopen if you feel documentation still isn't an accurate reflection