annotate hicup_filter.xml @ 7:2d4a34c00c67 draft default tip

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 398a2e3e845ada656b3a7e0a6542e1668a8bcf17
author bgruening
date Thu, 23 Feb 2023 18:06:05 +0000
parents daf29b40670f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
1 <tool id="hicup_filter" name="Hicup Filter" version="@VERSION@+galaxy0" profile="18.01">
4
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
2 <description>classifies read pairs, identifying valid Hi-C di-tags</description>
0
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
3 <macros>
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
4 <import>hicup_macros.xml</import>
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
5 </macros>
4
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
6 <expand macro="requirements_hicup"/>
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
8 #for $i, $file in enumerate($inputFiles):
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
9 #if $file.ext != 'sam':
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
10 ln -s '$file' ./${i}.bam &&
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
11 #end if
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
12 #end for
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
13 hicup_filter --zip --digest '$digest'
0
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
14 #if $advanced_options.longest:
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
15 --longest '$advanced_options.longest'
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
16 #end if
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
17 #if $advanced_options.shortest:
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
18 --shortest '$advanced_options.shortest'
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
19 #end if
4
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
20 #for $i, $file in enumerate($inputFiles):
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
21 #if $file.ext != 'sam':
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
22 ./${i}.bam
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
23 #else:
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
24 '$file'
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
25 #end if
0
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
26 #end for
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
27 ]]></command>
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
28 <inputs>
4
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
29 <param name="inputFiles" type="data" multiple="true" format="sam,qname_sorted.bam" label="Input files in BAM or SAM fomat"/>
5
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
30 <param argument="--digest" type="data" format="tabular" label="Genome digest file" help="Specify the genome digest file (created by hicup_digester)"/>
0
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
31 <section name="advanced_options" title="Advanced options">
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
32 <expand macro="filter_longest_shortest" />
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
33 </section>
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
34 </inputs>
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
35 <outputs>
4
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
36 <data name="dataset_filt" format="qname_sorted.bam" from_work_dir="*.filt.bam" label="filt.bam" />
5
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
37 <data name="hicup_filter_summary" format="tabular" from_work_dir="hicup_filter_summary*.txt" label="hicup_filter_summary.txt" />
4
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
38 <data name="contiguous_filter" format="qname_sorted.bam" from_work_dir="hicup_filter_ditag_rejects*/*contiguous.filter.bam" label="contiguous.filter.bam" />
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
39 <data name="re_ligation_filter" format="qname_sorted.bam" from_work_dir="hicup_filter_ditag_rejects*/*re_ligation.filter.bam" label="re_ligation.filter.bam" />
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
40 <data name="same_dangling_ends_filter" format="qname_sorted.bam" from_work_dir="hicup_filter_ditag_rejects*/*same_dangling_ends.filter.bam" label="same_dangling_ends.filter.bam" />
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
41 <data name="invalid_filter" format="qname_sorted.bam" from_work_dir="hicup_filter_ditag_rejects*/*invalid.filter.bam" label="invalid.filter.bam" />
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
42 <data name="same_circularised_filter" format="qname_sorted.bam" from_work_dir="hicup_filter_ditag_rejects*/*same_circularised.filter.bam" label="same_circularised.filter.bam" />
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
43 <data name="same_internal_filter" format="qname_sorted.bam" from_work_dir="hicup_filter_ditag_rejects*/*same_internal.filter.bam" label="same_internal.filter.bam" />
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
44 <data name="wrong_size_filter" format="qname_sorted.bam" from_work_dir="hicup_filter_ditag_rejects*/*wrong_size.filter.bam" label="wrong_size.filter.bam"/>
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
45 <data name="filter_piechart" format="svg" from_work_dir="*filter_piechart.svg" label="Filter piechart" />
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
46 <data name="ditag_size_distribution" format="svg" from_work_dir="*.ditag_size_distribution.svg" label="Ditag size distribution" />
0
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
47 </outputs>
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
48 <tests>
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
49 <test>
4
a7bbbf32da62 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit 22eec1b3b20b788e762837c02488f332f831fab3
bgruening
parents: 3
diff changeset
50 <param name="inputFiles" value="dataset1_2.pair.bam" ftype="qname_sorted.bam" />
7
2d4a34c00c67 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 398a2e3e845ada656b3a7e0a6542e1668a8bcf17
bgruening
parents: 5
diff changeset
51 <param name="digest" value="digest_file.txt" ftype="tabular" />
5
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
52 <output name="hicup_filter_summary">
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
53 <assert_contents>
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
54 <has_text_matching expression="\s+1143\s+544\s+44\s+440\s+60\s+599\s+21\s+73\s+466\s+39\s+0\s+0"/>
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
55 </assert_contents>
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
56 </output>
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
57 <output name="dataset_filt" file="dataset1_2.filt.bam" lines_diff="11" ftype="qname_sorted.bam" />
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
58 <output name="contiguous_filter" file="dataset1_2_contiguous.filter.bam" lines_diff="11" ftype="qname_sorted.bam" />
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
59 <output name="re_ligation_filter" file="dataset1_2_re_ligation.filter.bam" lines_diff="11" ftype="qname_sorted.bam" />
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
60 <output name="same_dangling_ends_filter" file="dataset1_2_same_dangling_ends.filter.bam" lines_diff="11" ftype="qname_sorted.bam" />
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
61 <output name="invalid_filter" file="dataset1_2_invalid.filter.bam" lines_diff="11" ftype="qname_sorted.bam" />
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
62 <output name="same_circularised_filter" file="dataset1_2_same_circularised.filter.bam" lines_diff="11" ftype="qname_sorted.bam" />
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
63 <output name="same_internal_filter" file="dataset1_2_same_internal.filter.bam" lines_diff="11" ftype="qname_sorted.bam" />
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
64 <output name="filter_piechart" file="dataset1_2.pair.bam.filter_piechart.svg" ftype="svg" compare="sim_size"/>
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
65 <output name="ditag_size_distribution" file="dataset1_2.ditag_size_distribution.svg" ftype="svg" compare="sim_size"/>
0
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
66 </test>
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
67 </tests>
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
68 <help><![CDATA[
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
69
5
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
70 For help please consult the documentation of HiCUP: https://www.bioinformatics.babraham.ac.uk/projects/hicup/read_the_docs/html/index.html
0
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
71
5
daf29b40670f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/hicup commit 5466e3345d762ed53686d80568929c2e15652eef
bgruening
parents: 4
diff changeset
72 To get more information about the filter visit: https://www.bioinformatics.babraham.ac.uk/projects/hicup/read_the_docs/html/index.html#hicup-filter
0
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
73 ]]></help>
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
74 <expand macro="citation_hicup" />
566da23a5a08 planemo upload for repository https://github.com/joachimwolff/galaxytools/tree/hicup/tools/hicup commit b77cbc104261f8aa1524922f41c2a9a23052f5da
bgruening
parents:
diff changeset
75 </tool>