Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

minimal manpage for rtax #3

Open
atzlinux opened this issue Oct 10, 2021 · 0 comments
Open

minimal manpage for rtax #3

atzlinux opened this issue Oct 10, 2021 · 0 comments

Comments

@atzlinux
Copy link

This minimal manpage for rtax come from Debian.
Welcome to add it to git repo.

https://sources.debian.org/src/rtax/0.984-7/debian/rtax.1/

The filename is rtax.1 .

.TH "rtax" 1 "27 Nov 2014"
.SH "NAME"
rtax - Rapid and accurate taxonomic classification of short paired-end sequence reads from the 16S ribosomal RNA gene
.SH "SYNOPSIS"
.B  rtax 
[\fIOPTION\fR]... 
.SH DESCRIPTION
.PP
.SH OPTIONS
.TP 13
.I \-r refd 
reference database in FASTA format
.TP 13
.I \-t taxonomy
taxonomy file with sequence IDs matching the reference database
.TP 13
.I \-a  queryA 
FASTA file containing query sequences (single-ended or read 1)
.TP 13
.I \-b  queryB
FASTA file containing query sequences (read b, with matching IDs)
.TP 13
.I \-x  
Reverse-complement query A sequences (required if they are provided in the reverse sense)
.TP 13
.I \-y  
Reverse-complement query B sequences (required if they are provided in the reverse sense)
.TP 13
.I \-i  regex
regular expression used to select part of the fasta header to use as the sequence id.  Default: "(\\S+)"
.TP 13
.I \-l  file
text file containing sequence IDs to process, one per line
.TP 13
.I \-d  delimiter
delimiter separating the two reads when provided in a single file
.TP 13
.I \-m  tempdir
temporary directory.  Will be removed on successful completion, but likely not if there is an error
.TP 13
.I \-f  
for sequences where only one read is available, fall back to single-ended classification.  Default: drop these sequences
.TP 13
.I \-g
for sequences where one read is overly generic, do not fall back to single-ended classification.  Default: classify these sequences based on only the more specific read
.TP 13
.I \-o  classifications.out
output path
.SH EXAMPLES
A quickstart example can be found here: \fIhttps://github.com/davidsoergel/rtax/wiki/QuickStart\fR
.P
Rtax can also be used within \fIQIIME\fR workflows, see this link for more information: \fIhttp://www.qiime.org/tutorials/rtax.html\fR
.SH AUTHOR
This manual page was written by Simon Kainz <simon@familiekainz.at> for the rtax package.
.P
Rtax was written by David A. W. Soergel <soergel@cs.umass.edu>.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant