annotate samtools_split_by_chrom.xml @ 0:a30dd3c77b30 draft

planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
author jjohnson
date Wed, 30 Nov 2016 16:46:40 -0500
parents
children 6fb39843d37d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
1 <tool id="samtools_split_by_chrom" name="Split BAM by Chromosome" version="2.0">
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
2 <description>into collection</description>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
3 <macros>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
4 <import>macros.xml</import>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
5 </macros>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
6 <!-- <code file="samtools_slice_options.py"/> -->
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
7 <expand macro="requirements"></expand>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
8 <expand macro="stdio"></expand>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
9 <expand macro="version_command"></expand>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
10 <command>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
11 <![CDATA[
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
12 mkdir -p outputs &&
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
13 ln -s "${input_bam}" temp_input.bam &&
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
14 ln -s "${input_bam.metadata.bam_index}" temp_input.bam.bai
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
15 #for $ref in str( $refs ).split(","):
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
16 && samtools view -@ \${GALAXY_SLOTS:-1} -bh inputs/temp_input.bam ${ref} |
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
17 samtools sort -O bam -T sorted -@ \${GALAXY_SLOTS:-1} -o "outputs/${input_bam.name}.${ref}.bam" -
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
18 #end for
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
19 ]]>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
20 </command>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
21 <inputs>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
22 <param name="input_bam" format="bam" label="Select BAM dataset to slice" type="data" />
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
23 <param name="refs" type="select" optional="False" multiple="True" label="Select references (chromosomes and contigs) you would like to restrict bam to" help="Click and type in the box above to see options. You can select multiple entries. If &quot;No options available&quot; is displayed, you need to re-detect metadata on the input dataset. See help section below.">
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
24 <!-- The options tagset below extracts reference names from bam file metadata -->
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
25 <!-- This will not work with bed files with old style metadata. However this -->
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
26 <!-- Can be easily fixed by re-deceting metadata on a bam dataset by clicking -->
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
27 <!-- The pencil icon and settind datatype to "bam" -->
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
28 <!-- This change has been commited in the following pull request: -->
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
29 <!-- https://github.com/galaxyproject/galaxy/pull/107 -->
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
30 <options>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
31 <filter type="data_meta" ref="input_bam" key="reference_names" />
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
32 </options>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
33 </param>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
34 </inputs>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
35 <outputs>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
36 <collection name="output_collection" type='list' label="${input_bam.name} by chrom">
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
37 <discover_datasets pattern="(?P&lt;designation&gt;.+)\.bam" directory="outputs" ext='bam'/>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
38 </collection>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
39 </outputs>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
40 <tests>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
41 <test>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
42 <param ftype="bam" name="input_bam" value="bam-slice-input.bam" />
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
43 <param name="refs" value="chrM" />
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
44 <output file="bam-slice-test2.bam" ftype="bam" name="output_bam" />
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
45 </test>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
46 </tests>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
47 <help>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
48 <![CDATA[
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
49
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
50 **What it does**
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
51
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
52 Creates a dataset collection of BAM files, one per selected chromosome.
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
53
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
54 This tool is based on ``samtools view`` command.
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
55
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
56 @no-chrom-options@
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
57
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
58 ]]>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
59 </help>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
60 <expand macro="citations"></expand>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
61 </tool>