← Back to branch summary

~ubuntu-branches/ubuntu/saucy/abyss/saucy

« back to all changes in this revision

Viewing changes to doc/abyss-pe.1

  • Committer: Package Import Robot
  • Author(s): Shaun Jackman
  • Date: 2011-09-11 10:00:13 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: package-import@ubuntu.com-20110911100013-oa4m5fi036mjuwc8
Tags: 1.3.0-1
* New upstream release.
* Add libboost-graph-dev to Build-Depends.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/abyss-pe.1
1
 
.TH abyss-pe "1" "2011-Apr" "abyss-pe (ABySS) 1.2.7" "User Commands"
 
1
.TH abyss-pe "1" "2011-Sep" "abyss-pe (ABySS) 1.3.0" "User Commands"
2
2
.SH NAME
3
3
abyss-pe - assemble reads into paired-end contigs
4
4
.SH SYNOPSIS
23
23
library.
24
24
.TP
25
25
\fBlib\fR
26
 
list of libraries. Use this varible when assembling data from multiple
27
 
fragment libraries. For each library in lib, a variable with the same
28
 
name must specify the files containing those reads.
 
26
list of paired-end libraries. Use this varible when assembling data
 
27
from multiple fragment libraries. For each library in lib, a variable
 
28
with the same name must specify the files containing those reads.
 
29
.TP
 
30
\fBpe\fR
 
31
list of paired-end libraries that will be used only for merging
 
32
contigs and will not contribute toward the consensus sequence.
 
33
.TP
 
34
\fBmp\fR
 
35
list of mate-pair libraries that will be used for scaffolding. By
 
36
default mate-pair libraries do not contribute toward the consensus
 
37
sequence.
29
38
.TP
30
39
\fBse\fR
31
40
files containing single-end reads
50
59
pop bubbles with identity at least p (default: 0.9)
51
60
.TP
52
61
\fBn\fR
53
 
minimum number of pairs. This parameter depends on coverage, but 10 is
54
 
a reasonable default.
 
62
minimum number of pairs (default: 10). The optimal value for this
 
63
parameter depends on coverage, but 10 is a reasonable default.
55
64
.TP
56
65
\fBs\fR
57
 
minimum length of a seed contig (default: 100). The seed length should
58
 
be at least twice the read length.
 
66
minimum length of a seed contig in bp (default: 200). The seed length
 
67
should be at least twice the value of k. If more sequence is assembled
 
68
than the expected genome size, try increasing s.
59
69
.TP
60
70
\fBd\fR
61
 
acceptable error of a distance estimate. The default is 6 bp.
 
71
acceptable error in bp of a distance estimate (default: 6).
62
72
.TP
63
73
\fBnp\fR, \fBNSLOTS\fR
64
74
the number of processes of an MPI assembly
67
77
the path to mpirun
68
78
.TP
69
79
\fBj\fR
70
 
the number of threads to use. Defaults to the value of np or 1.
 
80
the number of threads to use (default: 2). If np is specified, the
 
81
default is the value of np.
71
82
.TP
72
83
.B aligner
73
84
specify the program to use to align reads to contigs. May be
74
 
aligner=bwa or aligner=bowtie. The default is to use KAligner.
 
85
aligner=map, aligner=bwa or aligner=bowtie. The default is to use
 
86
KAligner.
75
87
.TP
76
88
\fBABYSS_OPTIONS\fR
77
89
additional options to the single-end assembler, ABYSS
101
113
The SGE environment variables JOB_NAME, SGE_TASK_ID and NSLOTS may be
102
114
used to specify the parameters name, k and np, respectively.
103
115
.SH EXAMPLES
104
 
.SS "Single library"
105
 
 abyss-pe k=25 n=10 name=ecoli in='reads1.fa reads2.fa'
106
 
.SS "Multiple libraries"
107
 
 abyss-pe k=25 n=10 name=ecoli lib='lib1 lib2' \\
 
116
.SS "One paired-end library"
 
117
 abyss-pe k=64 name=ecoli in='reads1.fa reads2.fa'
 
118
.SS "Multiple paired-end libraries"
 
119
 abyss-pe k=64 name=ecoli lib='lib1 lib2' \\
108
120
.br
109
121
        lib1='lib1_1.fa lib1_2.fa' lib2='lib2_1.fa lib2_2.fa' \\
110
122
.br
111
 
        se='se1.fa se2.fa' \\
112
 
.br
113
 
        lib2_n=25
 
123
        se='se1.fa se2.fa'
 
124
.SS "Paired-end and mate-pair libraries
 
125
 abyss-pe k=64 name=ecoli lib='pe1 pe2' mp='mp1 mp2' \\
 
126
.br
 
127
        pe1='pe1_1.fa pe1_2.fa' pe2='pe2_1.fa pe2_2.fa' \\
 
128
.br
 
129
        mp1='mp1_1.fa mp1_2.fa' mp2='mp2_1.fa mp2_2.fa' \\
 
130
.br
 
131
        se='se1.fa se2.fa'
114
132
.SS MPI
115
 
 abyss-pe np=8 k=25 n=10 name=ecoli in='reads1.fa reads2.fa'
 
133
 abyss-pe np=8 k=64 name=ecoli in='reads1.fa reads2.fa'
116
134
.SS SGE
117
 
 qsub -N ecoli -t 25 -pe openmpi 8 \\
 
135
 qsub -N ecoli -t 64 -pe openmpi 8 \\
118
136
.br
119
137
        abyss-pe n=10 in='reads1.fa reads2.fa'
120
138
.SH "SEE ALSO"
122
140
.SH AUTHOR
123
141
Written by Shaun Jackman.
124
142
.SH "REPORTING BUGS"
125
 
Report bugs to <abyss-users@bcgsc.ca>.
 
143
Report bugs to <abyss-users@googlegroups.com>.
126
144
.SH COPYRIGHT
127
 
Copyright 2009 Canada's Michael Smith Genome Science Centre
 
145
Copyright 2011 Canada's Michael Smith Genome Science Centre