annotate salsa2.xml @ 4:41c4e48b0617 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
author iuc
date Thu, 19 May 2022 14:16:51 +0000
parents 5af503c47367
children d6713454590c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
1 <tool id="salsa" name="SALSA" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="20.01">
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
2 <description>scaffold long read assemblies with Hi-C</description>
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
3 <macros>
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
4 <token name="@TOOL_VERSION@">2.3</token>
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
5 <token name="@VERSION_SUFFIX@">3</token>
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
6 </macros>
0
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
7 <xrefs>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
8 <xref type="bio.tools">SALSA</xref>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
9 </xrefs>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
10 <requirements>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
11 <requirement type="package" version="@TOOL_VERSION@">salsa2</requirement>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
12 <requirement type="package" version="1.11">samtools</requirement>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
13 </requirements>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
14 <command detect_errors="exit_code"><![CDATA[
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
15 ln -s '$fasta_in' input.fasta &&
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
16 samtools faidx input.fasta &&
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
17
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
18 run_pipeline.py
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
19 -a '$fasta_in'
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
20 -l input.fasta.fai
2
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
21 #if $enzyme_conditional.enzyme_options == 'preconfigured':
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
22 #if $enzyme_conditional.preconfigured_enzymes == 'dovetail'
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
23 -e 'GATC'
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
24 #else if $enzyme_conditional.preconfigured_enzymes == 'arima1'
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
25 -e 'GATC,GANTC'
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
26 #else
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
27 -e 'GATC,GANTC,CTNAG,TTAA'
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
28 #end if
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
29 #else:
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
30 -e '${enzyme_conditional.manual_enzyme}'
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
31 #end if
0
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
32 -b '$bed_file'
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
33 #if str($cutoff):
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
34 -c '$cutoff'
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
35 #end if
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
36 #if $gfa_file:
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
37 -g '$gfa_file'
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
38 #end if
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
39 #if $iter:
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
40 -i '$iter'
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
41 #end if
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
42 #if $gensize:
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
43 -s '$gensize'
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
44 #end if
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
45 -m '$clean'
0
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
46 -o ./out
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
47 ]]></command>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
48 <inputs>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
49 <param name="fasta_in" type="data" format="fasta" label="Initial assembly file" help="Headers must not contain ':'."/>
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
50 <param name="bed_file" type="data" format="bed" label="Bed alignment" help="To start scaffolding with SALSA, reads need to be mapped to the assembly.
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
51 BWA or BOWTIE2 are recommended. SALSA requires a bed file as the input. The alignment bam file can be converted using the bamToBed command from
3
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
52 the Bedtools package."/>
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
53 <param name="cutoff" argument="-c" type="integer" min="1" label="Cutoff" optional="true" help="Minimum contig length to scaffold"/>
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
54 <param name="gfa_file" argument="-g" type="data" format="gfa1,gfa2" optional="true" label="Sequence graphs"
3
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
55 help="An assembly graph can be optionally provided to guide the scaffolding, potentially reducing the scaffolding errors"/>
2
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
56 <conditional name="enzyme_conditional">
3
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
57 <param name="enzyme_options" type="select" label="Enzyme selection" help="Hi-C experiments can use different restriction enzymes.
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
58 The enzyme frequency in contigs is used to normalize the Hi-C interaction frequency. Note that you need to specify the actual
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
59 sequence of the cutting site for a restriction enzyme and not the enzyme name. You can also specify DNASE as an enzyme if you
3
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
60 use an enzyme-free prep, e.g. Omin-C.">
2
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
61 <option value="preconfigured">Preconfigured restriction enzymes</option>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
62 <option value="specific">Enter a specific sequence</option>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
63 </param>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
64 <when value="preconfigured">
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
65 <param name="preconfigured_enzymes" type="select" multiple="true" label="Preconfigured enzymes">
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
66 <option value="dovetail">Dovetail Chicago, Dovetail Hi-C or Phase: GATC</option>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
67 <option value="arima1">Arima Hi-C 1.0: GATC, GANTC</option>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
68 <option value="arima2">Arima Hi-C 2.0: GATC, GANTC, CTNAG, TTAA</option>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
69 </param>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
70 </when>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
71 <when value="specific">
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
72 <param name="manual_enzyme" argument="-e" type="text" label="Restriction enzyme sequence(s)"
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
73 help="Restriction enzyme sequence. If multiple were used, include all as a comma separated list without spaces (ex. 'GATC,AAGCTT').">
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
74 <validator type="expression" message="Only alphabetical letters and the comma can be used in to define restriction enzym sequences.">value.replace(',', '').isalpha()</validator>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
75 </param>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
76 </when>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
77 </conditional>
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
78 <param name="iter" argument="-i" type="integer" min="0" max="20" label="Iterations" optional="true"
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
79 help="SALSA will scaffold through sequential iterations. The default number of iterations is 3. Increasing the number of iterations will
3
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
80 potentially increase the number of joins, however it could also introduce additional misjoins"/>
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
81 <param name="clean" argument="-m" type="boolean" label="Clean Assembly" checked="false" truevalue='yes' falsevalue="no" help="Set this option to 'yes' if you want to find misassemblies in input assembly" />
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
82 <param name="gensize" argument="-s" type="integer" label="Expected Genome Size" optional="true" help="Expected Genome size of the assembled genome. If not set, Salsa will estimate genome size." />
0
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
83 </inputs>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
84 <outputs>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
85 <data name="scaffolds_fasta" format="fasta" from_work_dir="out/scaffolds_FINAL.fasta" label="${tool.name} on ${on_string}: FASTA assembly"/>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
86 <data name="scaffolds_agp" format="tabular" from_work_dir="out/scaffolds_FINAL.agp" label="${tool.name} on ${on_string}: agp output"/>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
87 </outputs>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
88 <tests>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
89 <test>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
90 <param name="fasta_in" value="test.fasta"/>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
91 <param name="length" value="test.fai"/>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
92 <param name="bed_file" value="test.bed"/>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
93 <param name="gfa_file" value="test.gfa1"/>
2
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
94 <conditional name="enzyme_conditional">
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
95 <param name="enzyme_options" value="specific"/>
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
96 <param name="manual_enzyme" value="GATC,GANTC"/>
2
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
97 </conditional>
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
98 <param name="enzyme" value="GATC,GANTC"/>
0
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
99 <param name="cutoff" value="1000"/>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
100 <param name="iter" value="3"/>
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
101 <param name="clean" value="yes"/>
0
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
102 <output name="scaffolds_fasta" file="out.fasta"/>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
103 <output name="scaffolds_agp" file="out.agp"/>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
104 </test>
2
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
105 <!--Test manual enzyme-->
0
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
106 <test>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
107 <param name="fasta_in" value="test.fasta"/>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
108 <param name="bed_file" value="test.bed"/>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
109 <param name="gfa_file" value="test.gfa1"/>
2
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
110 <conditional name="enzyme_conditional">
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
111 <param name="enzyme_options" value="specific"/>
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
112 <param name="manual_enzyme" value="GATC,GANTC"/>
2
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
113 </conditional>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
114 <param name="cutoff" value="1000"/>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
115 <param name="iter" value="3"/>
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
116 <param name="clean" value="yes"/>
2
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
117 <output name="scaffolds_fasta" file="out.fasta"/>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
118 <output name="scaffolds_agp" file="out.agp"/>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
119 </test>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
120 <!--Test predefined enzyme-->
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
121 <test>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
122 <param name="fasta_in" value="test.fasta"/>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
123 <param name="bed_file" value="test.bed"/>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
124 <param name="gfa_file" value="test.gfa1"/>
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
125 <conditional name="enzyme_conditional">
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
126 <param name="enzyme_options" value="preconfigured"/>
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
127 <param name="preconfigured_enzymes" value="arima1"/>
2
e15025381b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 59c5c8edd0c2080d7685e312fee19de1da75097e"
iuc
parents: 1
diff changeset
128 </conditional>
0
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
129 <param name="cutoff" value="1000"/>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
130 <param name="iter" value="3"/>
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
131 <param name="clean" value="yes"/>
0
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
132 <output name="scaffolds_fasta" file="out.fasta"/>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
133 <output name="scaffolds_agp" file="out.agp"/>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
134 </test>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
135 </tests>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
136 <help><![CDATA[
3
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
137 .. class:: infomark
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
138
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
139 **Purpose**
0
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
140
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
141 SALSA (Simple AssembLy ScAffolder) is a scaffolding tool based on a computational method that exploits the genomic proximity
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
142 information in Hi-C data sets for long range scaffolding of de novo genome assemblies.
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
143
3
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
144 ----
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
145
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
146 .. class:: infomark
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
147
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
148 **Mapping reads**
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
149
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
150 To start the scaffolding, first step is to map reads to the assembly. We recommend using `BWA <https://usegalaxy.eu/root?tool_id=toolshed.g2.bx.psu.edu/repos/devteam/bwa/bwa_mem/0.7.17.2>`_
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
151 or `BOWTIE2 <https://usegalaxy.eu/root?tool_id=toolshed.g2.bx.psu.edu/repos/devteam/bowtie2/bowtie2/2.4.2+galaxy0>`_ aligner to map reads. The read mapping generates a bam file. SALSA requires
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
152 BED file as the input. This can be done using the bamToBed command from the `Bedtools package <http://bedtools.readthedocs.io/en/latest/>`_. Also, SALSA requires BED files to be sorted by the
3
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
153 read name, rather than the alignment coordinates. Once you have bam file, you can run following commands to get the bam file needed as an input to SALSA.
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
154
4
41c4e48b0617 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 41b8952cd0739db0b5eb62d5dd9ccc7bc0f1925f
iuc
parents: 3
diff changeset
155 Since Hi-C reads and alignments contain experimental artifacts, the alignments needs some postprocessing. To align and postprocess
3
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
156 the alignments, you can use the pipeline released by Arima Genomics which can be found in the `GitHub repository <https://github.com/ArimaGenomics>`_.
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
157
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
158 Additional information on how to generate/filter the bam `here <https://github.com/marbl/SALSA#mapping-reads>`_.
5af503c47367 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 4904594e8df7cbd6eeee4be24023c6bd15e162de"
iuc
parents: 2
diff changeset
159
0
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
160 ]]></help>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
161 <citations>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
162 <citation type="doi">10.1101/261149</citation>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
163 <citation type="doi">10.1186/s12864-017-3879-z</citation>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
164 </citations>
18bd1bf98498 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/salsa2 commit 67cd735c6709a56ad1c4d65cd84e38fccd59603b"
iuc
parents:
diff changeset
165 </tool>