annotate findcluster.xml @ 30:9f0af01ad389 draft

planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit cbe482b98ef1dd753da7ffbc1fad7ba93f79ecc0
author mvdbeek
date Tue, 09 May 2017 12:53:56 -0400
parents 4be52149b343
children 5c32fb616d95
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
30
9f0af01ad389 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit cbe482b98ef1dd753da7ffbc1fad7ba93f79ecc0
mvdbeek
parents: 29
diff changeset
1 <tool id="findcluster" name="Find clusters of reads" version="0.3.23">
5
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
2 <description>in bam files</description>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
3 <requirements>
30
9f0af01ad389 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit cbe482b98ef1dd753da7ffbc1fad7ba93f79ecc0
mvdbeek
parents: 29
diff changeset
4 <requirement type="package" version="0.3.23">readtagger</requirement>
5
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
5 </requirements>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
6 <version_command>findcluster --version</version_command>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
7 <command detect_errors="aggressive"><![CDATA[
20
44bbb5c4553f planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit e3effe4ab3ded37fb610f53deb4d0082daf7fdac
mvdbeek
parents: 19
diff changeset
8 ln -f -s $input input.bam &&
44bbb5c4553f planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit e3effe4ab3ded37fb610f53deb4d0082daf7fdac
mvdbeek
parents: 19
diff changeset
9 ln -f -s $input.metadata.bam_index input.bam.bai &&
5
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
10 findcluster
20
44bbb5c4553f planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit e3effe4ab3ded37fb610f53deb4d0082daf7fdac
mvdbeek
parents: 19
diff changeset
11 --input_path input.bam
12
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
12 #if $reference_fasta:
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
13 --reference_fasta '$reference_fasta'
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
14 #end if
5
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
15 --output_bam '$output_bam'
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
16 --output_gff '$output_gff'
20
44bbb5c4553f planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit e3effe4ab3ded37fb610f53deb4d0082daf7fdac
mvdbeek
parents: 19
diff changeset
17 --output_fasta '$output_fasta'
5
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
18 --sample_name '$input.element_identifier'
9
04e14e0da336 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 1d14dc7cdb21c782dee08a1d5be1bd956d1a6dc8
mvdbeek
parents: 8
diff changeset
19 --threads "\${GALAXY_SLOTS:-2}"
5
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
20 ]]></command>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
21 <inputs>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
22 <param name="input" argument="--input_path" type="data" format="bam"/>
12
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
23 <param argument="--reference_fasta" label="Reference Fasta" help="Reconstructed contigs at clusters will be blasted against this sequence." type="data" format="fasta" optional="True"/>
5
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
24 </inputs>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
25 <outputs>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
26 <data name="output_bam" format="bam" label="findcluster BAM on $on_string"/>
20
44bbb5c4553f planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit e3effe4ab3ded37fb610f53deb4d0082daf7fdac
mvdbeek
parents: 19
diff changeset
27 <data name="output_fasta" format="fasta" label="findcluster contigs on $on_string"/>
5
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
28 <data name="output_gff" format="gff3" label="findcluster GFF on $on_string"/>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
29 </outputs>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
30 <tests>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
31 <test>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
32 <param name="input" value="extended_and_annotated_roi.bam" ftype="bam"/>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
33 <output name="output_bam" file="three_cluster_out.bam" ftype="bam" lines_diff="2"/>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
34 <output name="output_gff" file="three_cluster_out.gff" ftype="gff3" lines_diff="0"/>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
35 </test>
12
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
36 <test>
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
37 <param name="input" value="extended_and_annotated_roi.bam" ftype="bam"/>
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
38 <param name="reference_fasta" value="reference.fasta" ftype="fasta"/>
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
39 <output name="output_bam" file="three_cluster_out.bam" ftype="bam" lines_diff="2"/>
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
40 <output name="output_gff">
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
41 <assert_contents>
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
42 <has_text text="FBti0019066_rover_Gypsy" />
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
43 </assert_contents>
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
44 </output>
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
45 </test>
5
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
46 </tests>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
47 <help><![CDATA[
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
48 .. code-block::
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
49
12
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
50 Usage: findcluster [OPTIONS]
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
51
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
52 Find clusters of reads that support a TE insertion.
5
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
53
12
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
54 Options:
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
55 --input_path PATH Find cluster in this BAM file.
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
56 --output_bam PATH Write out BAM file with cluster information
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
57 to this path. Reads will have an additional
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
58 "CD" tag to indicate the cluster number
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
59 --output_gff PATH Write out GFF file with cluster information
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
60 to this path.
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
61 --sample_name TEXT Sample name to use when writing out clusters
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
62 in GFF file. Default is to infer the name
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
63 from the input filename.
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
64 --include_duplicates / --no-include_duplicates
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
65 Include reads marked as duplicates when
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
66 finding clusters.
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
67 --reference_fasta TEXT Blast cluster contigs against this fasta
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
68 file
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
69 --blastdb TEXT Blast cluster contigs against this blast
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
70 database
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
71 --threads INTEGER RANGE Threads to use for cap3 assembly step
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
72 --version Show the version and exit.
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
73 --help Show this message and exit.
c7ee722e48ad planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 13fe863ca4079d83d897fdf7e394a7474eea6117
mvdbeek
parents: 11
diff changeset
74
5
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
75
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
76 ]]></help>
f002e5797570 planemo upload for repository https://github.com/bardin-lab/readtagger/tree/master/galaxy commit 14a5033994a789097d1c61d1f3318397813d3d29
mvdbeek
parents:
diff changeset
77 </tool>