Mercurial > repos > devteam > bwa
comparison bwa.xml @ 4:ac30bfd3e2a8 draft
planemo upload commit a50a3947aebc8a1d11bac39599f4efd8ed9a3bd5
author | devteam |
---|---|
date | Thu, 18 Jun 2015 17:35:40 -0400 |
parents | 607ca4b95837 |
children | fbf460831036 |
comparison
equal
deleted
inserted
replaced
3:607ca4b95837 | 4:ac30bfd3e2a8 |
---|---|
1 <?xml version="1.0"?> | 1 <?xml version="1.0"?> |
2 <tool id="bwa" name="Map with BWA" version="0.2.1"> | 2 <tool id="bwa" name="Map with BWA" version="0.2.3"> |
3 <description>- map short reads (< 100 bp) against reference genome</description> | 3 <description>- map short reads (< 100 bp) against reference genome</description> |
4 <macros> | 4 <macros> |
5 <import>bwa_macros.xml</import> | 5 <import>bwa_macros.xml</import> |
6 <token name="@command_options@"> | 6 <token name="@command_options@"> |
7 #if str( $analysis_type.analysis_type_selector ) == "full": | 7 #if str( $analysis_type.analysis_type_selector ) == "full": |
22 #if str( $analysis_type.B ): | 22 #if str( $analysis_type.B ): |
23 -B ${analysis_type.B} | 23 -B ${analysis_type.B} |
24 #end if | 24 #end if |
25 | 25 |
26 #if str( $analysis_type.L ): | 26 #if str( $analysis_type.L ): |
27 -B ${analysis_type.L} | 27 -L ${analysis_type.L} |
28 #end if | 28 #end if |
29 #end if | 29 #end if |
30 </token> | 30 </token> |
31 <token name="@read_group_options@"> | 31 <token name="@read_group_options@"> |
32 #if str( $rg.rg_selector ) == "set": | 32 #if str( $rg.rg_selector ) == "set": |
248 | 248 |
249 samtools sort -f temporary_bam_file.bam ${bam_output} | 249 samtools sort -f temporary_bam_file.bam ${bam_output} |
250 </command> | 250 </command> |
251 | 251 |
252 <inputs> | 252 <inputs> |
253 | 253 |
254 <conditional name="reference_source"> | 254 <conditional name="reference_source"> |
255 <param name="reference_source_selector" type="select" label="Load reference genome from"> | 255 <param name="reference_source_selector" type="select" label="Will you select a reference genome from your history or use a built-in index?" help="Built-ins were indexed using default options. See `Indexes` section of help below"> |
256 <option value="cached">Local cache</option> | 256 <option value="cached">Use a built-in genome index</option> |
257 <option value="history">History</option> | 257 <option value="history">Use a genome from history and build index</option> |
258 </param> | 258 </param> |
259 <when value="cached"> | 259 <when value="cached"> |
260 <param name="ref_file" type="select" label="Using reference genome" help="Select genome from the list"> | 260 <param name="ref_file" type="select" label="Using reference genome" help="Select genome from the list"> |
261 <options from_data_table="bwa_mem_indexes"> | 261 <options from_data_table="bwa_mem_indexes"> |
262 <filter type="sort_by" column="2" /> | 262 <filter type="sort_by" column="2" /> |
385 <param name="input_type_selector" value="paired"/> | 385 <param name="input_type_selector" value="paired"/> |
386 <param name="fastq_input1" ftype="fastqsanger" value="bwa-mem-fastq1.fq"/> | 386 <param name="fastq_input1" ftype="fastqsanger" value="bwa-mem-fastq1.fq"/> |
387 <param name="fastq_input2" ftype="fastqsanger" value="bwa-mem-fastq2.fq"/> | 387 <param name="fastq_input2" ftype="fastqsanger" value="bwa-mem-fastq2.fq"/> |
388 <param name="rg_selector" value="set"/> | 388 <param name="rg_selector" value="set"/> |
389 <param name="ID" value="rg1"/> | 389 <param name="ID" value="rg1"/> |
390 <param name="PL" value="CAPILLARY"/> | |
390 <param name="analysis_type_selector" value="illumina"/> | 391 <param name="analysis_type_selector" value="illumina"/> |
391 <output name="bam_output" ftype="bam" file="bwa-aln-test3.bam" lines_diff="2" /> | 392 <output name="bam_output" ftype="bam" file="bwa-aln-test3.bam" lines_diff="2" /> |
392 </test> | 393 </test> |
393 </tests> | 394 </tests> |
394 <help> | 395 <help> |
395 **What is does** | 396 **What is does** |
396 | 397 |
397 BWA is a software package for mapping low-divergent sequences against a large reference genome, such as the human genome. The bwa-aln algorithm is designed for Illumina sequence reads up to 100bp. For longer reads use BWA-MEM algorithm distributed as separate Galaxy tool. | 398 BWA is a software package for mapping low-divergent sequences against a large reference genome, such as the human genome. The bwa-aln algorithm is designed for Illumina sequence reads up to 100bp. For longer reads use BWA-MEM algorithm distributed as a separate Galaxy tool. |
398 | 399 |
399 This Galaxy tool wraps bwa-aln, bwa-samse and -sampe modules of bwa read mapping tool: | 400 This Galaxy tool wraps bwa-aln, bwa-samse and -sampe modules of bwa read mapping tool: |
400 | 401 |
401 - bwa aln - actual mapper placing reads onto the reference sequence | 402 - **bwa aln** - actual mapper placing reads onto the reference sequence |
402 - bwa samse - post-processor converting suffix array coordinates into genome coordinates in SAM format for single reads | 403 - **bwa samse** - post-processor converting suffix array coordinates into genome coordinates in SAM format for single reads |
403 - bam sampe - post-processor for paired reads | 404 - **bam sampe** - post-processor for paired reads |
404 | 405 |
405 Galaxy implementation takes fastq or BAM (unaligned BAM) datasets as input and produces output in BAM (not SAM; in reality SAM produced by the bwa is converted to BAM on the fly by samtools view command) format, which can be further processed using various BAM utilities exiting in Galaxy (BAMTools, SAMTools, Picard). | 406 Galaxy implementation takes fastq or BAM (unaligned BAM) datasets as input and produces output in BAM (not SAM; in reality SAM produced by the bwa is converted to BAM on the fly by samtools view command) format, which can be further processed using various BAM utilities exiting in Galaxy (BAMTools, SAMTools, Picard). |
407 | |
408 ----- | |
409 | |
410 **Indices: Selecting reference genomes for BWA** | |
411 | |
412 Galaxy wrapper for BWA allows you select between precomputed and user-defined indices for reference genomes using **Will you select a reference genome from your history or use a built-in index?** flag. This flag has two options: | |
413 | |
414 1. **Use a built-in genome index** - when selected (this is default), Galaxy provides the user with **Select reference genome index** dropdown. Genomes listed in this dropdown have been pre-indexed with bwa index utility and are ready to be mapped against. | |
415 2. **Use a genome from the history and build index** - when selected, Galaxy provides the user with **Select reference genome sequence** dropdown. This dropdown is populated by all FASTA formatted files listed in your current history. If your genome of interest is uploaded into history it will be shown there. Selecting a genome from this dropdown will cause Galaxy to first transparently index it using `bwa index` command, and then run mapping with `bwa aln`. | |
416 | |
417 If your genome of interest is not listed here you have two choices: | |
418 | |
419 1. Contact galaxy team using **Help->Support** link at the top of the interface and let us know that an index needs to be added | |
420 2. Upload your genome of interest as a FASTA file to Galaxy history and selected **Use a genome from the history and build index** option. | |
406 | 421 |
407 ----- | 422 ----- |
408 | 423 |
409 **Galaxy-specific option** | 424 **Galaxy-specific option** |
410 | 425 |