changeset 4:7d3cd2087698 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/bam_to_cram commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
author iuc
date Tue, 28 Sep 2021 16:10:21 +0000
parents 3d07b8a6dd8c
children c2eda9a95b01
files macros.xml samtools_bam_to_cram.xml test-data/sam_to_bam_out2.bam test-data/test.bam test-data/test.cram test-data/test2.cram test-data/test_bam.cram test-data/test_chr1.cram test-data/test_regions.cram test-data/test_sam.cram
diffstat 10 files changed, 79 insertions(+), 48 deletions(-) [+]
line wrap: on
line diff
--- a/macros.xml	Thu Oct 17 02:16:13 2019 -0400
+++ b/macros.xml	Tue Sep 28 16:10:21 2021 +0000
@@ -5,10 +5,16 @@
             <yield/>
         </requirements>
     </xml>
-    <token name="@TOOL_VERSION@">1.9</token>
-    <token name="@FLAGS@">#set $flags = sum(map(int, str($filter).split(',')))</token>
+    <token name="@TOOL_VERSION@">1.13</token>
+    <token name="@PROFILE@">20.05</token>
+    <token name="@FLAGS@"><![CDATA[
+        #set $flags = 0
+        #if $filter
+            #set $flags = sum(map(int, str($filter).split(',')))
+        #end if
+    ]]></token>
     <token name="@PREPARE_IDX@"><![CDATA[
-        ##prepare input and indices 
+        ##prepare input and indices
         ln -s '$input' infile &&
         #if $input.is_of_type('bam'):
             #if str( $input.metadata.bam_index ) != "None":
@@ -25,7 +31,7 @@
         #end if
     ]]></token>
     <token name="@PREPARE_IDX_MULTIPLE@"><![CDATA[
-        ##prepare input and indices 
+        ##prepare input and indices
         #for $i, $bam in enumerate( $input_bams ):
             ln -s '$bam' '${i}' &&
             #if $bam.is_of_type('bam'):
@@ -63,6 +69,51 @@
             #set reffai=None
         #end if
     ]]></token>
+
+    <xml name="optional_reference">
+        <conditional name="addref_cond">
+            <param name="addref_select" type="select" label="Use a reference sequence">
+                <help>@HELP@</help>
+                <option value="no">No</option>
+                <option value="history">Use a genome/index from the history</option>
+                <option value="cached">Use a built-in genome</option>
+            </param>
+            <when value="no"/>
+            <when value="history">
+                <param name="ref" argument="@ARGUMENT@" type="data" format="fasta,fasta.gz" label="Reference"/>
+            </when>
+            <when value="cached">
+                <param name="ref" argument="@ARGUMENT@" type="select" label="Reference">
+                    <options from_data_table="fasta_indexes">
+                        <filter type="data_meta" ref="input" key="dbkey" column="dbkey"/>
+                    </options>
+                    <validator  type="no_options" message="No reference genome is available for the build associated with the selected input dataset"/>
+                </param>
+            </when>
+        </conditional>
+    </xml>
+    <xml name="mandatory_reference" token_help="" token_argument="">
+        <conditional name="addref_cond">
+            <param name="addref_select" type="select" label="Use a reference sequence">
+                <help>@HELP@</help>
+                <option value="history">Use a genome/index from the history</option>
+                <option value="cached">Use a built-in genome</option>
+            </param>
+            <when value="history">
+                <param name="ref" argument="@ARGUMENT@" type="data" format="fasta,fasta.gz" label="Reference"/>
+            </when>
+            <when value="cached">
+                <param name="ref" argument="@ARGUMENT@" type="select" label="Reference">
+                    <options from_data_table="fasta_indexes">
+                        <filter type="data_meta" ref="input" key="dbkey" column="dbkey"/>
+                        <validator message="No reference genome is available for the build associated with the selected input dataset" type="no_options" />
+                    </options>
+                </param>
+            </when>
+        </conditional>
+    </xml>
+
+
     <token name="@ADDTHREADS@"><![CDATA[
         ##compute the number of ADDITIONAL threads to be used by samtools (-@)
         addthreads=\${GALAXY_SLOTS:-1} && (( addthreads-- )) &&
@@ -70,28 +121,28 @@
     <token name="@ADDMEMORY@"><![CDATA[
         ##compute the number of memory available to samtools sort (-m)
         ##use only 75% of available: https://github.com/samtools/samtools/issues/831
-        addmemory=\${GALAXY_MEMORY_MB_PER_SLOT:-768} && 
+        addmemory=\${GALAXY_MEMORY_MB_PER_SLOT:-768} &&
         ((addmemory=addmemory*75/100)) &&
     ]]></token>
     <xml name="seed_input">
-       <param name="seed" type="integer" optional="True" label="Seed for random number generator" help="If empty a random seed is used." /> 
+       <param name="seed" type="integer" optional="True" label="Seed for random number generator" help="If empty a random seed is used." />
     </xml>
-    <xml name="flag_options">
-        <option value="1">read is paired</option>
-        <option value="2">read is mapped in a proper pair</option>
-        <option value="4">read is unmapped</option>
-        <option value="8">mate is unmapped</option>
-        <option value="16">read reverse strand</option>
-        <option value="32">mate reverse strand</option>
-        <option value="64">read is the first in a pair</option>
-        <option value="128">read is the second in a pair</option>
-        <option value="256">alignment or read is not primary</option>
-        <option value="512">read fails platform/vendor quality checks</option>
-        <option value="1024">read is a PCR or optical duplicate</option>
-        <option value="2048">supplementary alignment</option>
+    <xml name="flag_options" token_s1="false" token_s2="false" token_s4="false" token_s8="false" token_s16="false" token_s32="false" token_s64="false" token_s128="false" token_s256="false" token_s512="false" token_s1024="false" token_s2048="false">
+        <option value="1" selected="@S1@">Read is paired</option>
+        <option value="2" selected="@S2@">Read is mapped in a proper pair</option>
+        <option value="4" selected="@S4@">Read is unmapped</option>
+        <option value="8" selected="@S8@">Mate is unmapped</option>
+        <option value="16" selected="@S16@">Read is mapped to the reverse strand of the reference</option>
+        <option value="32" selected="@S32@">Mate is mapped to the reverse strand of the reference</option>
+        <option value="64" selected="@S64@">Read is the first in a pair</option>
+        <option value="128" selected="@S128@">Read is the second in a pair</option>
+        <option value="256" selected="@S256@">Alignment of the read is not primary</option>
+        <option value="512" selected="@S512@">Read fails platform/vendor quality checks</option>
+        <option value="1024" selected="@S1024@">Read is a PCR or optical duplicate</option>
+        <option value="2048" selected="@S2048@">Alignment is supplementary</option>
     </xml>
 
-    <!-- region specification macros and tokens for tools that allow the specification 
+    <!-- region specification macros and tokens for tools that allow the specification
          of region by bed file / space separated list of regions -->
     <token name="@REGIONS_FILE@"><![CDATA[
         #if $cond_region.select_region == 'tab':
--- a/samtools_bam_to_cram.xml	Thu Oct 17 02:16:13 2019 -0400
+++ b/samtools_bam_to_cram.xml	Tue Sep 28 16:10:21 2021 +0000
@@ -1,4 +1,4 @@
-<tool id="samtools_bam_to_cram" name="samtools BAM to CRAM" version="@TOOL_VERSION@">
+<tool id="samtools_bam_to_cram" name="samtools BAM to CRAM" version="@TOOL_VERSION@" profile="@PROFILE@">
     <description>convert BAM alignments to CRAM format</description>
 
     <macros>
@@ -20,7 +20,7 @@
 
             -@ \$addthreads
 	    -C
-	    -h 
+	    -h
             -o '${output_alignment}'
             -T '$reffa'
             -t '$reffai'
@@ -34,23 +34,7 @@
 
     <inputs>
         <param name="input" type="data" format="bam,sam" label="BAM (or SAM) alignment file"/>
-        <conditional name="addref_cond">
-            <param name="addref_select" type="select" label="Load reference genome from">
-                <option value="cached">Local cache</option>
-                <option value="history">History</option>
-            </param>
-            <when value="cached">
-                <param name="ref" type="select" label="Reference genome">
-                    <options from_data_table="fasta_indexes">
-                        <filter type="data_meta" ref="input" key="dbkey" column="dbkey" />
-                    </options>
-                    <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
-                </param>
-            </when>
-            <when value="history">
-                <param name="ref" type="data" format="fasta" label="Reference FASTA file"/>
-            </when>
-        </conditional>
+        <expand macro="mandatory_reference" argument="-t"/>
         <conditional name="parameter_regions">
             <param name="target_region" type="select" label="Choose conversion within specific genomic region(s)">
                 <option value="entire_input_file">Entire BAM alignment file</option>
@@ -78,16 +62,14 @@
             <param name="addref_select" value="history" />
             <param name="ref" value="test.fa" />
             <param name="target_region" value="entire_input_file" />
-
-            <output name="output_alignment" file="test.cram" compare="sim_size" delta="250" />
+            <output name="output_alignment" file="test_bam.cram" ftype="cram" compare="sim_size" delta="250" />
         </test>
         <test>
             <param name="input" value="test.sam" ftype="sam" />
             <param name="addref_select" value="history" />
             <param name="ref" value="test.fa" />
             <param name="target_region" value="entire_input_file" />
-
-            <output name="output_alignment" file="test.cram" compare="sim_size" delta="250" />
+            <output name="output_alignment" file="test_sam.cram" ftype="cram" compare="sim_size" delta="250" />
         </test>
         <test>
             <param name="input" value="test.bam" ftype="bam" />
@@ -95,8 +77,7 @@
             <param name="ref" value="test.fa" />
             <param name="target_region" value="region" />
             <param name="region_string" value="CHROMOSOME_I" />
-
-            <output name="output_alignment" file="test.cram" compare="sim_size" delta="250" />
+            <output name="output_alignment" file="test_chr1.cram" ftype="cram" compare="sim_size" delta="250" />
         </test>
         <test>
             <param name="input" value="test.bam" ftype="bam" />
@@ -104,15 +85,14 @@
             <param name="ref" value="test.fa" />
             <param name="target_region" value="regions_bed_file" />
             <param name="regions_bed_file" value="test.bed" ftype="bed" />
-
-            <output name="output_alignment" file="test.cram" compare="sim_size" delta="250" />
+            <output name="output_alignment" file="test_regions.cram" ftype="cram" compare="sim_size" delta="250" />
         </test>
         <test>
             <param name="input" ftype="bam" dbkey="equCab2" value="sam_to_bam_out2.bam" />
             <param name="addref_select" value="cached" />
             <param name="ref" value="equCab2chrM" />
             <param name="target_region" value="entire_input_file" />
-            <output name="output_alignment" file="test2.cram" compare="sim_size" delta="250" />
+            <output name="output_alignment" file="test2.cram" ftype="cram" compare="sim_size" delta="250" />
         </test>
     </tests>
 
Binary file test-data/sam_to_bam_out2.bam has changed
Binary file test-data/test.bam has changed
Binary file test-data/test.cram has changed
Binary file test-data/test2.cram has changed
Binary file test-data/test_bam.cram has changed
Binary file test-data/test_chr1.cram has changed
Binary file test-data/test_regions.cram has changed
Binary file test-data/test_sam.cram has changed