annotate repex_tarean.xml @ 7:65d1a27e9339 draft default tip

planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
author petr-novak
date Mon, 16 Oct 2023 09:19:52 +0000
parents 335d138b654b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
335d138b654b Uploaded
petr-novak
parents: 4
diff changeset
1 <tool id="tarean" name="Tandem Repeat Analyzer" version="2.3.8.1" >
0
15b422443267 Uploaded
petr-novak
parents:
diff changeset
2 <stdio>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
3 <regex match="Traceback" source="stderr" level="fatal" description="Unknown error" />
15b422443267 Uploaded
petr-novak
parents:
diff changeset
4 <regex match="error" source="stderr" level="fatal" description="Unknown error" />
15b422443267 Uploaded
petr-novak
parents:
diff changeset
5 <regex match="warning" source="stderr" level="warning" description="Unknown warning" />
15b422443267 Uploaded
petr-novak
parents:
diff changeset
6 <exit_code range="1:" level="fatal" description="Error" />
15b422443267 Uploaded
petr-novak
parents:
diff changeset
7 </stdio>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
8 <description>Identification of genomic tandem repeats from NGS data</description>
7
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
9 <requirements>
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
10 <container type="singularity">library://repeatexplorer/default/repex_tarean:0.3.8-dbaa07f</container>
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
11 </requirements>
0
15b422443267 Uploaded
petr-novak
parents:
diff changeset
12 <command detect_errors="exit_code">
15b422443267 Uploaded
petr-novak
parents:
diff changeset
13 export PYTHONHASHSEED=0;
7
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
14 seqclust --paired --sample ${read_sampling.sample} --output_dir=tarean_output --logfile=${log} --cleanup --tarean_mode
0
15b422443267 Uploaded
petr-novak
parents:
diff changeset
15 #if $advanced_options.advanced:
15b422443267 Uploaded
petr-novak
parents:
diff changeset
16 --mincl $advanced_options.size_threshold $advanced_options.keep_names $advanced_options.automatic_filtering -M $advanced_options.merging
15b422443267 Uploaded
petr-novak
parents:
diff changeset
17 #if $advanced_options.custom_library.options_custom_library :
15b422443267 Uploaded
petr-novak
parents:
diff changeset
18 -d $advanced_options.custom_library.library extra_database
15b422443267 Uploaded
petr-novak
parents:
diff changeset
19 #end if
15b422443267 Uploaded
petr-novak
parents:
diff changeset
20 #if $advanced_options.options.options:
15b422443267 Uploaded
petr-novak
parents:
diff changeset
21 -opt $advanced_options.options.options
15b422443267 Uploaded
petr-novak
parents:
diff changeset
22 #end if
15b422443267 Uploaded
petr-novak
parents:
diff changeset
23 #else:
15b422443267 Uploaded
petr-novak
parents:
diff changeset
24 -M 0.2
15b422443267 Uploaded
petr-novak
parents:
diff changeset
25
15b422443267 Uploaded
petr-novak
parents:
diff changeset
26 #end if
15b422443267 Uploaded
petr-novak
parents:
diff changeset
27 ${FastaFile} >stdout.log 2> stderr.log ;
15b422443267 Uploaded
petr-novak
parents:
diff changeset
28 echo "STDOUT CONTENT:" >> ${log} ;
15b422443267 Uploaded
petr-novak
parents:
diff changeset
29 cat stdout.log >> ${log} ;
15b422443267 Uploaded
petr-novak
parents:
diff changeset
30 echo "STDERR CONTENT:" >> ${log} ;
15b422443267 Uploaded
petr-novak
parents:
diff changeset
31 cat stderr.log >> ${log} &amp;&amp;
7
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
32 /opt/repex_tarean/stderr_filter.py stderr.log &amp;&amp;
0
15b422443267 Uploaded
petr-novak
parents:
diff changeset
33 cd tarean_output &amp;&amp;
15b422443267 Uploaded
petr-novak
parents:
diff changeset
34 zip -r ${ReportArchive}.zip * &amp;&amp;
15b422443267 Uploaded
petr-novak
parents:
diff changeset
35 mv ${ReportArchive}.zip ${ReportArchive} &amp;&amp;
15b422443267 Uploaded
petr-novak
parents:
diff changeset
36 cp index.html ${ReportFile} &amp;&amp;
7
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
37 mkdir -p ${ReportFile.extra_files_path} &amp;&amp;
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
38 cp -r --parents libdir ${ReportFile.extra_files_path} &amp;&amp;
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
39 cp -r --parents seqclust/clustering/superclusters ${ReportFile.extra_files_path} &amp;&amp;
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
40 cp -r --parents seqclust/clustering/clusters ${ReportFile.extra_files_path} &amp;&amp;
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
41 cp seqclust/clustering/hitsort.cls ${ReportFile.extra_files_path}/seqclust/clustering/hitsort.cls &amp;&amp;
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
42 cp *.png ${ReportFile.extra_files_path}/ &amp;&amp;
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
43 cp *.csv ${ReportFile.extra_files_path}/ &amp;&amp;
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
44 cp *.html ${ReportFile.extra_files_path}/ &amp;&amp;
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
45 cp *.css ${ReportFile.extra_files_path}/ &amp;&amp;
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
46 cp *.fasta ${ReportFile.extra_files_path}/ 2>>$log &amp;&amp; rm -r ../tarean_output || :
0
15b422443267 Uploaded
petr-novak
parents:
diff changeset
47
15b422443267 Uploaded
petr-novak
parents:
diff changeset
48
15b422443267 Uploaded
petr-novak
parents:
diff changeset
49 </command>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
50
15b422443267 Uploaded
petr-novak
parents:
diff changeset
51 <inputs>
1
2f52966cbaf1 documentation and help update
petr-novak
parents: 0
diff changeset
52 <param name="FastaFile" label="Paired-end Illumina reads" type="data" format="fasta"
2f52966cbaf1 documentation and help update
petr-novak
parents: 0
diff changeset
53 help="Input file must contain FASTA-formatted interlaced read pairs from paired-end sequencing. All pairs must be complete. Example of the input data format is provided in the help below."/>
2
09747b55badb Uploaded
petr-novak
parents: 1
diff changeset
54
4
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
55 <conditional name="read_sampling">
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
56 <param name="do_sampling" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Read sampling" help="Use this option if you want to analyze only a part of the reads" />
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
57 <when value="false">
2
09747b55badb Uploaded
petr-novak
parents: 1
diff changeset
58 <!-- pass -->
4
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
59 <param name="sample" label="Sample size" hidden="True" type="integer" value="0" help="Number of analyzed reads"/>
2
09747b55badb Uploaded
petr-novak
parents: 1
diff changeset
60 </when>
4
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
61 <when value="true">
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
62 <param name="sample" label="Sample size" type="integer" value="500000" min="10000" help="Number of analyzed reads"/>
2
09747b55badb Uploaded
petr-novak
parents: 1
diff changeset
63 </when>
09747b55badb Uploaded
petr-novak
parents: 1
diff changeset
64 </conditional>
09747b55badb Uploaded
petr-novak
parents: 1
diff changeset
65
0
15b422443267 Uploaded
petr-novak
parents:
diff changeset
66 <conditional name="advanced_options">
15b422443267 Uploaded
petr-novak
parents:
diff changeset
67 <param name="advanced" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Advanced options" />
15b422443267 Uploaded
petr-novak
parents:
diff changeset
68 <when value="false">
15b422443267 Uploaded
petr-novak
parents:
diff changeset
69 <!-- pass -->
15b422443267 Uploaded
petr-novak
parents:
diff changeset
70 </when>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
71 <when value="true">
15b422443267 Uploaded
petr-novak
parents:
diff changeset
72 <param name="merging" type="boolean" truevalue="0.2" falsevalue="0" checked="True" label="Perform cluster merging" help="By default, clusters connected through paired-end reads are merged"/>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
73 <conditional name="custom_library">
15b422443267 Uploaded
petr-novak
parents:
diff changeset
74 <param name="options_custom_library" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Use custom repeat database"/>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
75 <when value="false">
15b422443267 Uploaded
petr-novak
parents:
diff changeset
76 <!-- do nothing here -->
15b422443267 Uploaded
petr-novak
parents:
diff changeset
77 </when>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
78 <when value="true">
15b422443267 Uploaded
petr-novak
parents:
diff changeset
79 <param name="library" format="fasta" type="data" label="Use custom repeat database" help="Perform additional similarity search to user-provided repeat database. The database should contain FASTA-formatted DNA sequences with headers (sequence names) in the format: '>reapeatname#class/subclass'"/>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
80 </when>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
81 </conditional>
1
2f52966cbaf1 documentation and help update
petr-novak
parents: 0
diff changeset
82 <param name="size_threshold" label="Cluster size threshold for detailed analysis" type="float" value="0.01" min="0.0001" max="100" help ="Minimal size (as percentage of input reads) of the smallest cluster which is analyzed; cluster with less than 20 reads are not considered."/>
0
15b422443267 Uploaded
petr-novak
parents:
diff changeset
83 <param name="automatic_filtering" label="Perform automatic filtering of abundant satellite repeats" type="boolean" truevalue="--automatic_filtering" falsevalue="" checked="false"/>
1
2f52966cbaf1 documentation and help update
petr-novak
parents: 0
diff changeset
84 <param name="keep_names" label="Keep original read names" type="boolean" truevalue="--keep_names" falsevalue="" checked="false" help="By default, reads are renamed using integers. Use this option if you want to keep original names."/>
4
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
85 <conditional name="options">
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
86 <param name="options" type="select" label="Similarity search options">
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
87 <option value="ILLUMINA" selected="true">Default </option>
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
88 <option value="ILLUMINA_DUST_OFF" selected="false">Masking of low complexity repeats disabled </option>
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
89
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
90 <!-- <option value="ILLUMINA_SENSITIVE_MGBLAST" selected="false">Illumina reads, sensitive search (search parameters: mgblast, min PID 80, -W8) slow, experimental feature!</option> -->
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
91 <!-- <option value="ILLUMINA_SENSITIVE_BLASTPLUS" selected="false">Illumina reads, more sensitive search (search parameters: blastn, min PID 80, -W6) extremely slow, experimental feature!</option> -->
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
92 <!-- <option value="OXFORD_NANOPORE" selected="false"> -->
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
93 <!-- Pseudo short reads simulated from Oxford Nanopore data, experimental feature! -->
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
94 <!-- </option> -->
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
95 </param>
fe2220ee2fd1 Uploaded
petr-novak
parents: 3
diff changeset
96 </conditional>
0
15b422443267 Uploaded
petr-novak
parents:
diff changeset
97 </when>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
98 </conditional>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
99
7
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
100 <conditional name="queue_definition">
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
101 <param name="queue_select" type="select" label="Select queue">
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
102 <option value="basic_fast_queue">basic (max runtime 2 days, 4 GB RAM)</option>
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
103 <option value="long_slow_queue">long (max runtime 2 weeks, 64 GB RAM)</option>
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
104 <option value="extra_long_slow_queue">extra long (max runtime 4 weeks, 64 GB RAM)</option>
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
105 </param>
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
106 <when value="basic_fast_queue">
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
107 <param name="queue_specification" type="text" label="Modify parameters (optional)"
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
108 value="-l select=1:ncpus=10:mem=32gb:scratch_local=50gb -l walltime=48:00:00 -q elixirre@pbs.elixir-czech.cz -v TAREAN_MAX_MEM=4000000,TAREAN_CPU=4" />
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
109 </when>
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
110
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
111 <when value="long_slow_queue">
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
112 <param name="queue_specification" type="text" label="Modify parameters (optional)"
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
113 value="-l select=1:ncpus=16:mem=112gb:scratch_local=50gb -l walltime=336:00:00 -q elixirre@pbs.elixir-czech.cz -v TAREAN_MAX_MEM=64000000,TAREAN_CPU=15" />
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
114 </when>
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
115 <when value="extra_long_slow_queue">
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
116 <param name="queue_specification" type="text" label="Modify parameters (optional)"
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
117 value="-l select=1:ncpus=16:mem=112gb:scratch_local=50gb -l walltime=720:00:00 -q elixirre@pbs.elixir-czech.cz -v TAREAN_MAX_MEM=64000000,TAREAN_CPU=15" />
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
118 </when>
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
119 </conditional>
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
120
65d1a27e9339 planemo upload commit ccbd120278facd9aa39c1c46665ee994ebd3cff2-dirty
petr-novak
parents: 6
diff changeset
121
0
15b422443267 Uploaded
petr-novak
parents:
diff changeset
122
15b422443267 Uploaded
petr-novak
parents:
diff changeset
123 </inputs>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
124 <outputs>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
125 <data name="log" format="txt" label="TAREAN log file"/>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
126 <data name="ReportArchive" format="zip" label="TAREAN Archive with HTML report from data ${FastaFile.hid}"/>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
127 <data name="ReportFile" format="html" label="TAREAN HTML report from data ${FastaFile.hid}"/>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
128 </outputs>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
129
15b422443267 Uploaded
petr-novak
parents:
diff changeset
130 <help>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
131 **HELP**
15b422443267 Uploaded
petr-novak
parents:
diff changeset
132
15b422443267 Uploaded
petr-novak
parents:
diff changeset
133 TAREAN - TAndem REpeat ANalyzer is a computational pipeline for
15b422443267 Uploaded
petr-novak
parents:
diff changeset
134 **unsupervised identification of satellite repeats** from unassembled
15b422443267 Uploaded
petr-novak
parents:
diff changeset
135 sequence reads. The pipeline uses low-pass paired-end whole genome
15b422443267 Uploaded
petr-novak
parents:
diff changeset
136 sequence reads and performs graph-based clustering. The resulting
15b422443267 Uploaded
petr-novak
parents:
diff changeset
137 clusters, representing all types of repeats present in the genome, are
15b422443267 Uploaded
petr-novak
parents:
diff changeset
138 then examined to identify those containing circular structures indicative
15b422443267 Uploaded
petr-novak
parents:
diff changeset
139 of tandem repeats. A poster summarizing TAREAN principles and
15b422443267 Uploaded
petr-novak
parents:
diff changeset
140 implementation can be found `here.`__
15b422443267 Uploaded
petr-novak
parents:
diff changeset
141
15b422443267 Uploaded
petr-novak
parents:
diff changeset
142
15b422443267 Uploaded
petr-novak
parents:
diff changeset
143 .. __: http://w3lamc.umbr.cas.cz/lamc/?page_id=312
15b422443267 Uploaded
petr-novak
parents:
diff changeset
144
15b422443267 Uploaded
petr-novak
parents:
diff changeset
145 **Input data**
15b422443267 Uploaded
petr-novak
parents:
diff changeset
146
15b422443267 Uploaded
petr-novak
parents:
diff changeset
147
15b422443267 Uploaded
petr-novak
parents:
diff changeset
148 The analysis requires **paired-end reads** generated by whole genome
15b422443267 Uploaded
petr-novak
parents:
diff changeset
149 shotgun sequencing. The data should be provided as a single input file in
15b422443267 Uploaded
petr-novak
parents:
diff changeset
150 fasta format with the reads interlaced (see example below). All the pairs
15b422443267 Uploaded
petr-novak
parents:
diff changeset
151 must be complete, i.e. both "forward" and "reverse" sequence reads must be
15b422443267 Uploaded
petr-novak
parents:
diff changeset
152 present. The reads should all be trimmed to the same length. The optimal
15b422443267 Uploaded
petr-novak
parents:
diff changeset
153 size range is between 100 and 200 nucleotides. The number of reads to be
15b422443267 Uploaded
petr-novak
parents:
diff changeset
154 analyzed should not exceed 1x coverage of the genome. Genome coverage
15b422443267 Uploaded
petr-novak
parents:
diff changeset
155 between 0.01 and 0.5x is recommended. The reads should be filtered for
15b422443267 Uploaded
petr-novak
parents:
diff changeset
156 quality. The recommended quality filtering is as follows: each read should
15b422443267 Uploaded
petr-novak
parents:
diff changeset
157 have a quality score >=10 for 95% of the bases, i.e. if your reads are 100
15b422443267 Uploaded
petr-novak
parents:
diff changeset
158 base pairs long, then a read only passes this quality threshold if 95
15b422443267 Uploaded
petr-novak
parents:
diff changeset
159 bases have a quality of 10 or higher. Additionally, any reads containing
15b422443267 Uploaded
petr-novak
parents:
diff changeset
160 indeterminate base pairs (indicated as N in the reads) should be removed.
15b422443267 Uploaded
petr-novak
parents:
diff changeset
161 Finally, if either one of the reads in a pair fails to meet the
15b422443267 Uploaded
petr-novak
parents:
diff changeset
162 aforementioned thresholds, **both** sequences should be removed.
15b422443267 Uploaded
petr-novak
parents:
diff changeset
163 example of interlaced input format::
15b422443267 Uploaded
petr-novak
parents:
diff changeset
164
15b422443267 Uploaded
petr-novak
parents:
diff changeset
165 >0001_f
15b422443267 Uploaded
petr-novak
parents:
diff changeset
166 CGTAATATACATACTTGCTAGCTAGTTGGATGCATCCAACTTGCAAGCTAGTTTGATG
15b422443267 Uploaded
petr-novak
parents:
diff changeset
167 >0001_r
15b422443267 Uploaded
petr-novak
parents:
diff changeset
168 GATTTGACGGACACACTAACTAGCTAGTTGCATCTAAGCGGGCACACTAACTAACTAT
15b422443267 Uploaded
petr-novak
parents:
diff changeset
169 >0002_f
15b422443267 Uploaded
petr-novak
parents:
diff changeset
170 ACTCATTTGGACTTAACTTTGATAATAAAAACTTAAAAAGGTTTCTGCACATGAATCG
15b422443267 Uploaded
petr-novak
parents:
diff changeset
171 >0002_r
15b422443267 Uploaded
petr-novak
parents:
diff changeset
172 TATGTTGAAAAATTGAATTTCGGGACGAAACAGCGTCTATCGTCACGACATAGTGCTC
15b422443267 Uploaded
petr-novak
parents:
diff changeset
173 >0003_f
15b422443267 Uploaded
petr-novak
parents:
diff changeset
174 TGACATTTGTGAACGTTAATGTTCAACAAATCTTTCCAATGTCTTTTTATCTTATCAT
15b422443267 Uploaded
petr-novak
parents:
diff changeset
175 >0003_r
15b422443267 Uploaded
petr-novak
parents:
diff changeset
176 TATTGAAATACTGGACACAAATTGGAAATGAAACCTTGTGAGTTATTCAATTTATGTT
15b422443267 Uploaded
petr-novak
parents:
diff changeset
177 ...
15b422443267 Uploaded
petr-novak
parents:
diff changeset
178
15b422443267 Uploaded
petr-novak
parents:
diff changeset
179
15b422443267 Uploaded
petr-novak
parents:
diff changeset
180 To perform the quality filtering on your fastQ formatted data as described
15b422443267 Uploaded
petr-novak
parents:
diff changeset
181 above, and to interlace your paired-end sequence reads,
15b422443267 Uploaded
petr-novak
parents:
diff changeset
182 please use the `Preprocessing of paired-reads`__ tool.
15b422443267 Uploaded
petr-novak
parents:
diff changeset
183
15b422443267 Uploaded
petr-novak
parents:
diff changeset
184 .. __: tool_runner?tool_id=paired_fastq_filtering
15b422443267 Uploaded
petr-novak
parents:
diff changeset
185
15b422443267 Uploaded
petr-novak
parents:
diff changeset
186
15b422443267 Uploaded
petr-novak
parents:
diff changeset
187 **Additional parameters**
15b422443267 Uploaded
petr-novak
parents:
diff changeset
188
15b422443267 Uploaded
petr-novak
parents:
diff changeset
189 **Sample size** defines how many reads will be used during the computation.
15b422443267 Uploaded
petr-novak
parents:
diff changeset
190 The default setting of 500,000 reads will enable detection of high copy
15b422443267 Uploaded
petr-novak
parents:
diff changeset
191 number satellites within several hours. For higher
15b422443267 Uploaded
petr-novak
parents:
diff changeset
192 sensitivity the sample size can be increased. Since the sample size affects
15b422443267 Uploaded
petr-novak
parents:
diff changeset
193 memory usage, this parameter may be automatically adjusted to a lower value
15b422443267 Uploaded
petr-novak
parents:
diff changeset
194 during the run. The maximum sample size which can be processed depends on the
15b422443267 Uploaded
petr-novak
parents:
diff changeset
195 repetitiveness of the analyzed genome. This significantly limits the number of reads
15b422443267 Uploaded
petr-novak
parents:
diff changeset
196 that can be analyzed with the TAREAN pipeline.
15b422443267 Uploaded
petr-novak
parents:
diff changeset
197
15b422443267 Uploaded
petr-novak
parents:
diff changeset
198 **Perform cluster merging**. Families of repetitive elements are
15b422443267 Uploaded
petr-novak
parents:
diff changeset
199 frequently split into multiple clusters rather than being represented as a
15b422443267 Uploaded
petr-novak
parents:
diff changeset
200 single one. If you do not want to merge clusters based on the presence
15b422443267 Uploaded
petr-novak
parents:
diff changeset
201 of broken read pairs, disable this option.
15b422443267 Uploaded
petr-novak
parents:
diff changeset
202
15b422443267 Uploaded
petr-novak
parents:
diff changeset
203 **Use custom repeat database**. This option allows users to perform similarity
15b422443267 Uploaded
petr-novak
parents:
diff changeset
204 comparison of identified repeats to their custom databases. The repeat class should
15b422443267 Uploaded
petr-novak
parents:
diff changeset
205 be encoded in FASTA headers of database entries in order to allow correct
15b422443267 Uploaded
petr-novak
parents:
diff changeset
206 parsing of similarity hits.
15b422443267 Uploaded
petr-novak
parents:
diff changeset
207
15b422443267 Uploaded
petr-novak
parents:
diff changeset
208 **Similarity search options** By default sequence reads are compared using
15b422443267 Uploaded
petr-novak
parents:
diff changeset
209 mgblast program. Default threshold is explicitly set to 90% sequence
15b422443267 Uploaded
petr-novak
parents:
diff changeset
210 similarity spanning at least 55% of the read length (in the case of reads
15b422443267 Uploaded
petr-novak
parents:
diff changeset
211 differing in length it applies to the longer one). Additionally, sequence
15b422443267 Uploaded
petr-novak
parents:
diff changeset
212 overlap must be at least 55 nt. If you select option for shorter reads
15b422443267 Uploaded
petr-novak
parents:
diff changeset
213 than 100 nt, minimum overlap 55 nt is not required.
15b422443267 Uploaded
petr-novak
parents:
diff changeset
214
15b422443267 Uploaded
petr-novak
parents:
diff changeset
215 By default,
15b422443267 Uploaded
petr-novak
parents:
diff changeset
216 mgblast search use DUST program to filter out
15b422443267 Uploaded
petr-novak
parents:
diff changeset
217 low-complexity sequences. If you want
15b422443267 Uploaded
petr-novak
parents:
diff changeset
218 to increase sensitivity of detection of satellites with shorter monomer
15b422443267 Uploaded
petr-novak
parents:
diff changeset
219 use option with '*no masking of low complexity repeats*'. Note that omitting
15b422443267 Uploaded
petr-novak
parents:
diff changeset
220 DUST filtering will significantly increase running times
15b422443267 Uploaded
petr-novak
parents:
diff changeset
221
15b422443267 Uploaded
petr-novak
parents:
diff changeset
222 **Output**
15b422443267 Uploaded
petr-novak
parents:
diff changeset
223
15b422443267 Uploaded
petr-novak
parents:
diff changeset
224 A list of clusters identified as putative satellite repeats, their genomic
15b422443267 Uploaded
petr-novak
parents:
diff changeset
225 abundance and various cluster characteristics are provided. Length and
15b422443267 Uploaded
petr-novak
parents:
diff changeset
226 consensus sequences of reconstructed monomers are also shown and
15b422443267 Uploaded
petr-novak
parents:
diff changeset
227 accompanied by a detailed output from kmer-based reconstruction including
15b422443267 Uploaded
petr-novak
parents:
diff changeset
228 sequences and sequence logos of alternative variants of monomer sequences.
15b422443267 Uploaded
petr-novak
parents:
diff changeset
229
15b422443267 Uploaded
petr-novak
parents:
diff changeset
230 The output includes an **HTML summary** with a table listing all analyzed
15b422443267 Uploaded
petr-novak
parents:
diff changeset
231 clusters. More detailed information about clusters is provided in
15b422443267 Uploaded
petr-novak
parents:
diff changeset
232 additional files and directories. All results are also provided as a
15b422443267 Uploaded
petr-novak
parents:
diff changeset
233 downloadable **zip archive**. Since read clustering results in
15b422443267 Uploaded
petr-novak
parents:
diff changeset
234 thousands of clusters, the search for satellite repeats is limited to
15b422443267 Uploaded
petr-novak
parents:
diff changeset
235 a subset of the largest ones corresponding to the most abundant genomic
15b422443267 Uploaded
petr-novak
parents:
diff changeset
236 repeats. The default setting of the pipeline is to analyze all clusters containing at least
15b422443267 Uploaded
petr-novak
parents:
diff changeset
237 0.01% of the input reads. Besides the satellite repeats, three other
15b422443267 Uploaded
petr-novak
parents:
diff changeset
238 groups of clusters are reported in the output (1) LTR-retrotransposons,
15b422443267 Uploaded
petr-novak
parents:
diff changeset
239 (2) 45S and 5S rDNA and (3) all remaining clusters passing the size
15b422443267 Uploaded
petr-novak
parents:
diff changeset
240 threshold. As (1) and (2) contain sequences with circular
15b422443267 Uploaded
petr-novak
parents:
diff changeset
241 graphs, their consensus is calculated in the same way as for satellite
15b422443267 Uploaded
petr-novak
parents:
diff changeset
242 repeats. Additionally a **log file** reporting the progress of the
15b422443267 Uploaded
petr-novak
parents:
diff changeset
243 computational pipeline is provided.
15b422443267 Uploaded
petr-novak
parents:
diff changeset
244
15b422443267 Uploaded
petr-novak
parents:
diff changeset
245
15b422443267 Uploaded
petr-novak
parents:
diff changeset
246 </help>
15b422443267 Uploaded
petr-novak
parents:
diff changeset
247
15b422443267 Uploaded
petr-novak
parents:
diff changeset
248 </tool>