Mercurial > repos > devteam > samtools_reheader
changeset 2:30388d878f81 draft
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_reheader commit f667915d861dbf0a25cc8fd132cc956d82e73ee9"
| author | iuc |
|---|---|
| date | Thu, 02 Jul 2020 05:25:02 -0400 |
| parents | db000c6007a0 |
| children | bb8cfc6f6e0c |
| files | macros.xml samtools_reheader.xml |
| diffstat | 2 files changed, 134 insertions(+), 21 deletions(-) [+] |
line wrap: on
line diff
--- a/macros.xml Tue May 09 11:18:23 2017 -0400 +++ b/macros.xml Thu Jul 02 05:25:02 2020 -0400 @@ -1,11 +1,131 @@ <macros> <xml name="requirements"> <requirements> - <requirement type="package" version="1.3.1">samtools</requirement> + <requirement type="package" version="@TOOL_VERSION@">samtools</requirement> <yield/> </requirements> </xml> - <token name="@TOOL_VERSION@">1.3.1</token> + <token name="@TOOL_VERSION@">1.9</token> + <token name="@FLAGS@">#set $flags = sum(map(int, str($filter).split(',')))</token> + <token name="@PREPARE_IDX@"><![CDATA[ + ##prepare input and indices + ln -s '$input' infile && + #if $input.is_of_type('bam'): + #if str( $input.metadata.bam_index ) != "None": + ln -s '${input.metadata.bam_index}' infile.bai && + #else: + samtools index infile infile.bai && + #end if + #elif $input.is_of_type('cram'): + #if str( $input.metadata.cram_index ) != "None": + ln -s '${input.metadata.cram_index}' infile.crai && + #else: + samtools index infile infile.crai && + #end if + #end if + ]]></token> + <token name="@PREPARE_IDX_MULTIPLE@"><![CDATA[ + ##prepare input and indices + #for $i, $bam in enumerate( $input_bams ): + ln -s '$bam' '${i}' && + #if $bam.is_of_type('bam'): + #if str( $bam.metadata.bam_index ) != "None": + ln -s '${bam.metadata.bam_index}' '${i}.bai' && + #else: + samtools index '${i}' '${i}.bai' && + #end if + #elif $bam.is_of_type('cram'): + #if str( $bam.metadata.cram_index ) != "None": + ln -s '${bam.metadata.cram_index}' '${i}.crai' && + #else: + samtools index '${i}' '${i}.crai' && + #end if + #end if + #end for + ]]></token> + <token name="@PREPARE_FASTA_IDX@"><![CDATA[ + ##checks for reference data ($addref_cond.addref_select=="history" or =="cached") + ##and sets the -t/-T parameters accordingly: + ##- in case of history a symbolic link is used because samtools (view) will generate + ## the index which might not be possible in the directory containing the fasta file + ##- in case of cached the absolute path is used which allows to read the cram file + ## without specifying the reference + #if $addref_cond.addref_select == "history": + ln -s '${addref_cond.ref}' reference.fa && + samtools faidx reference.fa && + #set reffa="reference.fa" + #set reffai="reference.fa.fai" + #elif $addref_cond.addref_select == "cached": + #set reffa=str($addref_cond.ref.fields.path) + #set reffai=str($addref_cond.ref.fields.path)+".fai" + #else + #set reffa=None + #set reffai=None + #end if + ]]></token> + <token name="@ADDTHREADS@"><![CDATA[ + ##compute the number of ADDITIONAL threads to be used by samtools (-@) + addthreads=\${GALAXY_SLOTS:-1} && (( addthreads-- )) && + ]]></token> + <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=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." /> + </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 is mapped to the reverse strand of the reference</option> + <option value="32">Mate is mapped to the reverse strand of the reference</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 of the 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">Alignment is supplementary</option> + </xml> + + <!-- 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': + -t '$cond_region.targetregions' + #end if + ]]></token> + <token name="@REGIONS_MANUAL@"><![CDATA[ + #if $cond_region.select_region == 'text': + #for $i, $x in enumerate($cond_region.regions_repeat): + '${x.region}' + #end for + #end if + ]]></token> + <xml name="regions_macro"> + <conditional name="cond_region"> + <param name="select_region" type="select" label="Filter by regions" help="restricts output to only those alignments which overlap the specified region(s)"> + <option value="no" selected="True">No</option> + <option value="text">Manualy specify regions</option> + <option value="tab">Regions from tabular file</option> + </param> + <when value="no"/> + <when value="text"> + <repeat name="regions_repeat" min="1" default="1" title="Regions"> + <param name="region" type="text" label="region" help="format chr:from-to"> + <validator type="regex" message="Required format: CHR[:FROM[-TO]]; where CHR: string containing any character except quotes, whitespace and colon; FROM and TO: any integer">^[^\s'\":]+(:\d+(-\d+){0,1}){0,1}$</validator> + </param> + </repeat> + </when> + <when value="tab"> + <param name="targetregions" argument="-t/--target-regions" type="data" format="tabular" label="Target regions file" help="Do stats in these regions only. Tab-delimited file chr,from,to (1-based, inclusive)" /> + </when> + </conditional> + </xml> + <xml name="citations"> <citations> <citation type="bibtex"> @@ -49,21 +169,4 @@ <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>
--- a/samtools_reheader.xml Tue May 09 11:18:23 2017 -0400 +++ b/samtools_reheader.xml Thu Jul 02 05:25:02 2020 -0400 @@ -1,4 +1,4 @@ -<tool id="samtools_reheader" name="Reheader" version="2.0.1"> +<tool id="samtools_reheader" name="Reheader" version="2.0.1+galaxy1"> <description>copy SAM/BAM header between datasets</description> <macros> <import>macros.xml</import> @@ -10,11 +10,15 @@ samtools reheader '${input_header}' '${input_file}' + ${no_pg} > '${output}' ]]></command> <inputs> <param name="input_header" type="data" format="sam,bam" label="Select source dataset" help="Header from this dataset will be used to replace header in the target dataset. May be either SAM or BAM dataset."/> <param name="input_file" type="data" format="bam" label="Select target dataset" help="Header from the source dataset will be inserted here. Should be a BAM dataset."/> + <param argument="--no-PG" name="no_pg" type="boolean" truevalue="--no-PG" falsevalue="" + label="Keep the new header unmodified?" + help="By default, samtools reheader will add itself to the chain of tools used to manipulate the target dataset, which will cause one or more @PG records to be inserted into the new header. If you want the output dataset to end up with the header of the source dataset exactly, you should activate this option." /> </inputs> <outputs> <data format="bam" name="output" label="${tool.name} on ${on_string}" /> @@ -25,11 +29,17 @@ <param name="input_file" ftype="bam" value="reheader_input_file.bam"/> <output name="output" ftype="bam" file="reheader_out.bam" lines_diff="1"/><!-- samtools adds reheader line --> </test> + <test> + <param name="input_header" ftype="bam" value="reheader_input_header.bam"/> + <param name="input_file" ftype="bam" value="reheader_input_file.bam"/> + <param name="no_pg" value="true"/> + <output name="output" ftype="bam" file="reheader_out.bam" /> + </test> </tests> <help> **What it does** -Copies header from *source* dataset into *target* dataset using ``samtools reheader`` command. +Generates a new BAM dataset with the contents of *target* dataset, but the header of *source* dataset using the ``samtools reheader`` command. </help> <expand macro="citations"/> </tool>