annotate revertR2orientationInBam.xml @ 1:21ddefab2e4f draft default tip

planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit 49a42d0e75d6ae7faa3ce399524157c35546fbaa
author lldelisle
date Thu, 20 Oct 2022 10:51:18 +0000
parents 05aa21d39189
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
21ddefab2e4f planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit 49a42d0e75d6ae7faa3ce399524157c35546fbaa
lldelisle
parents: 0
diff changeset
1 <tool id="revertR2orientationInBam" name="revertR2orientationInBam" version="0.0.2" profile="16.04">
0
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
2 <description> Revert the mapped orientation of R2 mates in a bam.</description>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
3 <requirements>
1
21ddefab2e4f planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit 49a42d0e75d6ae7faa3ce399524157c35546fbaa
lldelisle
parents: 0
diff changeset
4 <requirement type="package" version="1.16.1">samtools</requirement>
21ddefab2e4f planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit 49a42d0e75d6ae7faa3ce399524157c35546fbaa
lldelisle
parents: 0
diff changeset
5 <requirement type="package" version="5.1.0">gawk</requirement>
0
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
6 </requirements>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
7 <stdio>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
8 <!-- Anything other than zero is an error -->
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
9 <exit_code range="1:" />
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
10 <exit_code range=":-1" />
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
11 <!-- In case the return code has not been set propery check stderr too -->
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
12 <regex match="Error:" />
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
13 <regex match="Exception:" />
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
14 </stdio>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
15 <command>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
16 <![CDATA[
1
21ddefab2e4f planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit 49a42d0e75d6ae7faa3ce399524157c35546fbaa
lldelisle
parents: 0
diff changeset
17 set -o pipefail;
21ddefab2e4f planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit 49a42d0e75d6ae7faa3ce399524157c35546fbaa
lldelisle
parents: 0
diff changeset
18 bash $__tool_directory__/revertR2orientationInBam.sh '$input' '$output'
0
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
19 ]]>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
20 </command>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
21 <inputs>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
22 <!-- note unsorted bam includes all derived bam types (inlcuding bam which is sorted) -->
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
23 <param name="input" type="data" format="sam,bam" label="Select a sam or bam file."/>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
24 </inputs>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
25 <outputs>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
26 <data format="bam" name="output" label="$input.name with R2 orientation reversed"/>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
27 </outputs>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
28
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
29 <tests>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
30 <test>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
31 <param name="input" value="input.sam"/>
1
21ddefab2e4f planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit 49a42d0e75d6ae7faa3ce399524157c35546fbaa
lldelisle
parents: 0
diff changeset
32 <output name="output" file="output.bam" ftype="bam" lines_diff="2"/>
0
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
33 </test>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
34 </tests>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
35 <help>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
36 <![CDATA[
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
37 This tool is very useful when you have paired-end stranded RNA-seq.
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
38 Using this tool prior to a bedtools genome coverage allow to have strand specific coverage using both mates.
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
39 It uses samtools to convert input to sam format and then awk to modify the flag "reverse strand" for the second mate of pairs.
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
40 ]]>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
41 </help>
05aa21d39189 planemo upload for repository https://github.com/lldelisle/tools-lldelisle/tree/master/tools/revertR2orientationInBam commit fe9813fe41ba241b47f7b2b4e4c9672ef35c0b35-dirty
lldelisle
parents:
diff changeset
42 </tool>