'\" t
.\"     Title: ariba
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "ARIBA" "1" "" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ariba \- Antibiotic Resistance Identification By Assembly
.SH "SYNOPSIS"
.sp
\fBariba\fP <subtool> [options]
.SH "DESCRIPTION"
.sp
\fBariba\fP is the main executable for the \fBARIBA\fP software, a
tool that identifies antibiotic resistance genes by running
local assemblies.
.sp
In general, the input is a FASTA file of reference sequences
(can be a mix of genes and noncoding sequences) and paired
sequencing reads. ARIBA reports which of the reference sequence
were found, plus detailed information on the quality of the
assemblies and any variants between the sequencing reads and the
reference sequences.
.sp
The actual functionality is provided by the subtools listed below.
.SS "Subtools"
.sp
\fBgetref\fP
.RS 4
download reference data
.RE
.sp
\fBprepareref\fP
.RS 4
prepare reference data for input to "run"
.RE
.sp
\fBrun\fP
.RS 4
run the ARIBA local assembly pipeline
.RE
.sp
\fBrefquery\fP
.RS 4
get cluster or sequence info from prepareref output
.RE
.sp
\fBreportfilter\fP
.RS 4
Filter report.tsv file
.RE
.sp
\fBsummary\fP
.RS 4
summarise multiple reports made by "run"
.RE
.sp
\fBflag\fP
.RS 4
translate the meaning of a flag
.RE
.sp
\fBaln2meta\fP
.RS 4
converts multi\-aln fasta and SNPs to metadata
.RE
.sp
\fBtest\fP
.RS 4
run small built\-in test dataset
.RE
.sp
\fBversion\fP
.RS 4
get versions and exit
.RE
.SS "Subtool help"
.sp
You can run
.sp
.if n .RS 4
.nf
.fam C
ariba <subtool> \-\-help
.fam
.fi
.if n .RE
.sp
to show more information about how to run each subtool.
.SH "BUGS"
.sp
Please report bugs to the ARIBA issue tracker:
.URL "https://github.com/sanger\-pathogens/ariba/issues" "" ""