annotate findcluster.xml @ 29:2c62ca47c455 draft

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