annotate wisecondor_npz_converter.xml @ 0:bf0ebc9921f2 draft default tip

planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
author artbio
date Sun, 15 Dec 2024 16:37:13 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
1 <tool id="wisecondorx_npz_converter" name="WisecondorX convert" version="@WRAPPER_VERSION@" profile="@PROFILE@">
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
2 <description>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
3 bam to npz
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
4 </description>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
5 <macros>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
6 <import>macro.xml</import>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
7 </macros>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
8 <expand macro="requirements"/>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
9 <stdio>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
10 <exit_code range="1:" level="fatal" description="Error occured" />
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
11 </stdio>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
12 <command detect_errors="exit_code"><![CDATA[
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
13 @pipefail@
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
14 ln -f -s $bam.metadata.bam_index input.bam.bai &&
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
15 ln -f -s $bam input.bam &&
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
16 printf "Creating 5kb bins for file $bam.element_identifier" &&
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
17 WisecondorX convert input.bam output.npz
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
18 ]]></command>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
19 <inputs>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
20 <param name="bam" type="data" label="Bam input" format="bam"
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
21 help="input Bam is converted in .npz file"/>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
22 </inputs>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
23 <outputs>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
24 <data name="npz" format="npz" from_work_dir="output.npz" label="${on_string}.npz" />
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
25 </outputs>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
26 <tests>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
27 <test expect_num_outputs="1">
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
28 <param ftype="bam" name="bam" value="npz_convert_input.bam" />
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
29 <output name="npz" ftype="npz" file="npz_convert_output.npz" compare="sim_size" delta="10000"/>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
30 </test>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
31 </tests>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
32 <help>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
33 @help@
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
34 <![CDATA[
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
35 .. class:: infomark
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
36
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
37 **WisecondorX convert input.bam/cram output.npz [--optional arguments]**
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
38
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
39 Option List::
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
40
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
41 --reference Fasta reference to be used with cram inputs.
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
42 This option is currently not available in this Galaxy wrapper,
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
43 which takes only bam inputs.
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
44 --binsize Size per bin in bp; the reference bin size should be a multiple of this value.
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
45 Note that this parameter does not impact the resolution, yet it
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
46 can be used to optimize processing speed (default: x=5e3).
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
47 The --binsize parameter is currently not exposed in this Galaxy
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
48 wrapper and is fixed to 5e3
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
49 --normdup Use this flag to avoid duplicate removal.
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
50 The --normdup parameter is currently not exposed in this Galaxy
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
51 wrapper. Default is to remove duplicates.
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
52
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
53 ]]></help>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
54 <citations>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
55 <citation type="doi">10.1093/nar/gky1263</citation>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
56 </citations>
bf0ebc9921f2 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/wisecondorx commit b391b0f3348bd86a5c276dc4d3ff9dc98890c115
artbio
parents:
diff changeset
57 </tool>