'\" t
.\"     Title: dipspades
.\"    Author: [see the "AUTHORS" section]
.\" Generator: Asciidoctor 1.5.6.2
.\"      Date: 
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "DIPSPADES" "1" "" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.LINKSTYLE blue R < >
.SH "NAME"
dipspades \- diploid genome assembler
.SH "SYNOPSIS"
.sp
\fBdipspades\fP [options] \-o <output_dir>
.SH "DESCRIPTION"
.sp
\fBdipspades\fP is the main executable for the \fBdipSPAdes\fP software, a genome
assembler designed for diploid genomes with a high heterozygosity rate. It
assembles genomic reads given to it and places the resulting assembly in
<output_dir>.
.SH "OPTIONS"
.SS "Basic options"
.sp
\fB\-o\fP <output_dir>
.RS 4
directory to store all the resulting files (required)
.RE
.sp
\fB\-\-iontorrent\fP
.RS 4
this flag is required for IonTorrent data
.RE
.sp
\fB\-\-test\fP
.RS 4
runs dipSPAdes on toy dataset
.RE
.sp
\fB\-h\fP/\fB\-\-help\fP
.RS 4
prints this usage message
.RE
.SS "Input data"
.sp
\fB\-\-12\fP <filename>
.RS 4
file with interlaced forward and reverse paired\-end reads
.RE
.sp
\fB\-1\fP <filename>
.RS 4
file with forward paired\-end reads
.RE
.sp
\fB\-2\fP <filename>
.RS 4
file with reverse paired\-end reads
.RE
.sp
\fB\-s\fP <filename>
.RS 4
file with unpaired reads
.RE
.sp
\fB\-\-pe<#>\-12\fP <filename>
.RS 4
file with interlaced reads for paired\-end library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-pe<#>\-1\fP <filename>
.RS 4
file with forward reads for paired\-end library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-pe<#>\-2\fP <filename>
.RS 4
file with reverse reads for paired\-end library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-pe<#>\-s\fP <filename>
.RS 4
file with unpaired reads for paired\-end library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-pe<#>\-<or>\fP
.RS 4
orientation of reads for paired\-end library number <#> (<#> = 1,2,3,4,5; <or> = fr, rf, ff)
.RE
.sp
\fB\-\-s<#>\fP <filename>
.RS 4
file with unpaired reads for single reads library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-mp<#>\-12\fP  <filename>
.RS 4
file with interlaced reads for mate\-pair library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-mp<#>\-1\fP <filename>
.RS 4
file with forward reads for mate\-pair library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-mp<#>\-2\fP <filename>
.RS 4
file with reverse reads for mate\-pair library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-mp<#>\-s\fP <filename>
.RS 4
file with unpaired reads for mate\-pair library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-mp<#>\-<or>\fP
.RS 4
orientation of reads for mate\-pair library number <#> (<#> = 1,2,3,4,5; <or> = fr, rf, ff)
.RE
.sp
\fB\-\-hqmp<#>\-12\fP <filename>
.RS 4
file with interlaced reads for high\-quality mate\-pair library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-hqmp<#>\-1\fP <filename>
.RS 4
file with forward reads for high\-quality mate\-pair library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-hqmp<#>\-2\fP <filename>
.RS 4
file with reverse reads for high\-quality mate\-pair library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-hqmp<#>\-s\fP <filename>
.RS 4
file with unpaired reads for high\-quality mate\-pair library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-hqmp<#>\-<or>\fP
.RS 4
orientation of reads for high\-quality mate\-pair library number <#> (<#> = 1,2,3,4,5; <or> = fr, rf, ff)
.RE
.sp
\fB\-\-nxmate<#>\-1\fP <filename>
.RS 4
file with forward reads for Lucigen NxMate library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-nxmate<#>\-2\fP <filename>
.RS 4
file with reverse reads for Lucigen NxMate library number <#> (<#> = 1,2,3,4,5)
.RE
.sp
\fB\-\-sanger\fP <filename>
.RS 4
file with Sanger reads
.RE
.sp
\fB\-\-pacbio\fP <filename>
.RS 4
file with PacBio reads
.RE
.sp
\fB\-\-nanopore\fP <filename>
.RS 4
file with Nanopore reads
.RE
.sp
\fB\-\-trusted\-contigs\fP <filename>
.RS 4
file with trusted contigs
.RE
.sp
\fB\-\-untrusted\-contigs\fP <filename>
.RS 4
file with untrusted contigs
.RE
.SS "Input haplocontigs"
.sp
\fB\-\-hap\fP <filename>
.RS 4
file with haplocontigs
.RE
.SS "Pipeline options"
.sp
\fB\-\-only\-assembler\fP
.RS 4
runs only assembling (without read error correction)
.RE
.sp
\fB\-\-disable\-gzip\-output\fP
.RS 4
forces error correction not to compress the corrected reads
.RE
.sp
\fB\-\-disable\-rr\fP
.RS 4
disables repeat resolution stage of assembling
.RE
.SS "dipSPAdes options"
.sp
\fB\-\-expect\-gaps\fP
.RS 4
indicates that significant number of gaps in coverage is expected
.RE
.sp
\fB\-\-expect\-rearrangements\fP
.RS 4
indicates that significant number of rearrangements between haplomes of diploid genome is expected
.RE
.sp
\fB\-\-hap\-assembly\fP
.RS 4
enables haplotype assembly phase
.RE
.SS "Advanced options"
.sp
\fB\-\-dataset\fP <filename>
.RS 4
file with dataset description in YAML format
.RE
.sp
\fB\-t\fP/\fB\-\-threads\fP <int>
.RS 4
number of threads [default: 16]
.RE
.sp
\fB\-m\fP/\fB\-\-memory\fP <int>
.RS 4
RAM limit for SPAdes in Gb (terminates if exceeded) [default: 250]
.RE
.sp
\fB\-\-tmp\-dir\fP <dirname>
.RS 4
directory for temporary files [default: <output_dir>/tmp]
.RE
.sp
\fB\-k\fP <int,int,...>
.RS 4
comma\-separated list of k\-mer sizes (must be odd and less than 128) [default: \(aqauto\(aq]
.RE
.sp
\fB\-\-cov\-cutoff\fP <float>
.RS 4
coverage cutoff value (a positive float number, or \(aqauto\(aq, or \(aqoff\(aq) [default: \(aqoff\(aq]
.RE
.sp
\fB\-\-phred\-offset\fP <33 or 64>
.RS 4
PHRED quality offset in the input reads (33 or 64) [default: auto\-detect]
.RE