Mercurial > repos > devteam > samtools_split
changeset 0:57f3e32f809d draft
Uploaded
author | devteam |
---|---|
date | Tue, 21 Apr 2015 17:44:16 -0400 |
parents | |
children | b7f7826ef1cd |
files | macros.xml samtools_split.xml test-data/phiX.bam test-data/phiX_Elephant.bam test-data/phiX_Human.bam test-data/phiX_Mouse.bam test-data/samtools_split_out.bam tool_dependencies.xml |
diffstat | 8 files changed, 123 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/macros.xml Tue Apr 21 17:44:16 2015 -0400 @@ -0,0 +1,70 @@ +<macros> + <xml name="requirements"> + <requirements> + <requirement type="package" version="1.2">samtools</requirement> + <yield/> + </requirements> + </xml> + <xml name="citations"> + <citations> + <citation type="bibtex"> + @misc{SAM_def, + title={Definition of SAM/BAM format}, + url = {https://samtools.github.io/hts-specs/SAMv1.pdf},} + </citation> + <citation type="doi">10.1093/bioinformatics/btp352</citation> + <citation type="doi">10.1093/bioinformatics/btr076</citation> + <citation type="doi">10.1093/bioinformatics/btr509</citation> + <citation type="bibtex"> + @misc{Danecek_et_al, + Author={Danecek, P., Schiffels, S., Durbin, R.}, + title={Multiallelic calling model in bcftools (-m)}, + url = {http://samtools.github.io/bcftools/call-m.pdf},} + </citation> + <citation type="bibtex"> + @misc{Durbin_VCQC, + Author={Durbin, R.}, + title={Segregation based metric for variant call QC}, + url = {http://samtools.github.io/bcftools/rd-SegBias.pdf},} + </citation> + <citation type="bibtex"> + @misc{Li_SamMath, + Author={Li, H.}, + title={Mathematical Notes on SAMtools Algorithms}, + url = {http://www.broadinstitute.org/gatk/media/docs/Samtools.pdf},} + </citation> + <citation type="bibtex"> + @misc{SamTools_github, + title={SAMTools GitHub page}, + url = {https://github.com/samtools/samtools},} + </citation> + </citations> + </xml> + <xml name="version_command"> + <version_command>samtools --version | head -n 1 | awk '{ print $2 }'</version_command> + </xml> + <xml name="stdio"> + <stdio> + <exit_code range="1:" level="fatal" description="Error" /> + </stdio> + </xml> + <token name="@no-chrom-options@"> +----- + +.. class:: warningmark + +**No options available? How to re-detect metadata** + +If you see a "No options available" within the "**Select references (chromosomes and contigs) you would like to restrict bam to**" drop down, you need to re-detect metadata for the dataset you are trying to process. To do this follow these steps: + +1. Click on the **pencil** icon adjacent to the dataset in the history +2. A new menu will appear in the center pane of the interface +3. Click **Datatype** tab +4. Set **New Type** to **BAM** +5. Click **Save** + +The medatada will be re-detected and you will be able to see the list of reference sequences in the "**Select references (chromosomes and contigs) you would like to restrict bam to**" drop-down. + + </token> + +</macros>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/samtools_split.xml Tue Apr 21 17:44:16 2015 -0400 @@ -0,0 +1,47 @@ +<tool id="samtools_split" name="Split" version="1.1"> + <description>BAM dataset on readgroups</description> + <macros> + <import>macros.xml</import> + </macros> + <expand macro="requirements"></expand> + <expand macro="stdio"></expand> + <expand macro="version_command"></expand> + <command><![CDATA[ + samtools split -f 'Read_Group_%!.bam' + #if $header: + -u "${output}":"${header}" + #else: + -u "${output}" + #end if + "${input_bam}" + ]]></command> + <inputs> + <param name="input_bam" type="data" format="bam" label="BAM file" /> + <param name="header" type="data" format="bam,sam" label="Replace header in output file" optional="True" /> + </inputs> + <outputs> + <data format="bam" name="output" label="${tool.name} on ${on_string}"> + <discover_datasets pattern="Read_Group_(?P<designation>.+)\.bam" ext="bam" visible="true" directory="" /> + </data> + </outputs> + <tests> + <test> + <param name="input_bam" value="phiX.bam" ftype="bam" /> + <output name="output" file="samtools_split_out.bam"> + <discovered_dataset designation="Mouse" ftype="bam" file="phiX_Mouse.bam" /> + <discovered_dataset designation="Elephant" ftype="bam" file="phiX_Elephant.bam" /> + <discovered_dataset designation="Human" ftype="bam" file="phiX_Human.bam" /> + </output> + </test> + </tests> + <help> +**What it does** + +Splits BAM files on readgroups. + +This tool is based on ``samtools split`` command. It will generate multiple output datasets for each redagroup from the input dataset. + + </help> + <expand macro="citations"></expand> +</tool> +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/tool_dependencies.xml Tue Apr 21 17:44:16 2015 -0400 @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<tool_dependency> + <package name="samtools" version="1.2"> + <repository changeset_revision="6eea04363026" name="package_samtools_1_2" owner="iuc" toolshed="https://toolshed.g2.bx.psu.edu" /> + </package> +</tool_dependency>