Mercurial > repos > drosofff > msp_sr_bowtie
annotate sRbowtie.xml @ 4:615d2550977f draft
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
| author | drosofff |
|---|---|
| date | Wed, 09 Nov 2016 11:20:44 -0500 |
| parents | 68b71bd388eb |
| children | b2c1ffe6579a |
| rev | line source |
|---|---|
|
3
68b71bd388eb
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit 263dcfb32e54c4a033cf4a584b961938da969848
mvdbeek
parents:
2
diff
changeset
|
1 <tool id="bowtieForSmallRNA" name="sRbowtie" version="1.1.2.1"> |
| 0 | 2 <description>for FASTA small reads</description> |
| 3 <requirements> | |
|
3
68b71bd388eb
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit 263dcfb32e54c4a033cf4a584b961938da969848
mvdbeek
parents:
2
diff
changeset
|
4 <requirement type="package" version="1.1.2">bowtie</requirement> |
|
1
71b072cf5dde
planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
0
diff
changeset
|
5 <requirement type="package" version="1.2">samtools</requirement> |
| 0 | 6 </requirements> |
|
4
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
7 <command><![CDATA[ |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
8 python '$__tool_directory__'/sRbowtie.py |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
9 --input '$input' |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
10 --input-format '$input.extension' |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
11 --method '$method' |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
12 --v-mismatches $v_mismatches |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
13 --output-format $output_format |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
14 --output '$output' |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
15 --index-from '$refGenomeSource.genomeSource' |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
16 ## the very source of the index (indexed or fasta file) |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
17 --index-source |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
18 #if $refGenomeSource.genomeSource == "history": |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
19 '$refGenomeSource.ownFile' |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
20 #else: |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
21 '$refGenomeSource.index.fields.path' |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
22 #end if |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
23 --aligned '$aligned' |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
24 --unaligned '$unaligned' |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
25 --num-threads \${GALAXY_SLOTS:-4} ## number of processors to be handled by bowtie |
|
615d2550977f
planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_sr_bowtie commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents:
3
diff
changeset
|
26 ]]></command> |
| 0 | 27 <inputs> |
| 28 <param format="fasta, fastq" help="Only with clipped, raw fasta files" label="Input fasta file: reads clipped from their adapter" name="input" type="data" /> | |
| 29 <param help="bowtie parameters adjusted to the type of matching. RNA option match to only one strand" label="What kind of matching do you want to do?" name="method" type="select"> | |
| 30 <option value="RNA">Match on sense strand RNA reference index, multiple mappers randomly matched at a single position</option> | |
| 31 <option value="unique">Match unique mappers on DNA reference index</option> | |
| 32 <option selected="true" value="multiple">Match on DNA, multiple mappers randomly matched at a single position</option> | |
| 33 <option value="k_option">Match on DNA as fast as possible, without taking care of mapping issues (for raw annotation of reads)</option> | |
| 34 <option value="n_option">Match on DNA - RNAseq mode (-n bowtie option)</option> | |
| 35 <option value="a_option">Match and report all valid alignments</option> | |
| 36 </param> | |
| 37 <param help="specify the -v bowtie option" label="Number of mismatches allowed" name="v_mismatches" type="select"> | |
| 38 <option value="0">0</option> | |
| 39 <option selected="true" value="1">1</option> | |
| 40 <option value="2">2</option> | |
| 41 <option value="3">3</option> | |
| 42 </param> | |
| 43 <conditional name="refGenomeSource"> | |
| 44 <param help="Built-ins were indexed using default options" label="Will you select a reference genome from your history or use a built-in index?" name="genomeSource" type="select"> | |
| 45 <option value="indexed">Use a built-in index</option> | |
| 46 <option value="history">Use one from the history</option> | |
| 47 </param> | |
| 48 <when value="indexed"> | |
| 49 <param help="if your genome of interest is not listed - contact instance administrator" label="Select a DNA reference index" name="index" type="select"> | |
| 50 <options from_data_table="bowtie_indexes"> | |
| 51 | |
| 52 </options> | |
| 53 </param> | |
| 54 </when> | |
| 55 <when value="history"> | |
| 56 <param format="fasta" label="Select a fasta file, to serve as index reference" name="ownFile" type="data" /> | |
| 57 </when> | |
| 58 </conditional> | |
| 59 <param help="Note that the BAM will be viewable in trackster only if you choose a full genome referenced for Trackster usage. see the doc below" label="Select output format" name="output_format" type="select"> | |
|
1
71b072cf5dde
planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
0
diff
changeset
|
60 <option selected="true" value="tabular">tabular</option> |
| 0 | 61 <option value="sam">sam</option> |
| 62 <option value="bam">bam</option> | |
| 63 </param> | |
| 64 <param help="to get aligned and unaligned reads in fasta format" label="additional fasta output" name="additional_fasta" type="select"> | |
|
1
71b072cf5dde
planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
0
diff
changeset
|
65 <option selected="true" value="No">No</option> |
| 0 | 66 <option value="al">aligned</option> |
| 67 <option value="unal">unaligned</option> | |
| 68 <option value="al_and_unal">both aligned and unaligned</option> | |
| 69 </param> | |
| 70 </inputs> | |
| 71 <outputs> | |
| 72 <data format="tabular" label="Bowtie Output" name="output"> | |
| 73 <change_format> | |
| 74 <when format="sam" input="output_format" value="sam" /> | |
| 75 <when format="bam" input="output_format" value="bam" /> | |
| 76 </change_format> | |
| 77 <actions> | |
| 78 <conditional name="refGenomeSource.genomeSource"> | |
| 79 <when value="indexed"> | |
| 80 <action name="dbkey" type="metadata"> | |
| 81 <option column="1" name="bowtie_indexes" offset="0" type="from_data_table"> | |
| 82 <filter column="0" compare="startswith" keep="False" type="param_value" value="#" /> | |
| 83 <filter column="0" ref="refGenomeSource.index" type="param_value" /> | |
| 84 </option> | |
| 85 </action> | |
| 86 </when> | |
| 87 <when value="history"> | |
| 88 <action name="dbkey" type="metadata"> | |
| 89 <option name="refGenomeSource.ownFile" param_attribute="dbkey" type="from_param" /> | |
| 90 </action> | |
| 91 </when> | |
| 92 </conditional> | |
| 93 </actions> | |
| 94 </data> | |
| 95 <data format="fasta" label="Matched reads" name="aligned"> | |
| 96 <filter>additional_fasta == "al" or additional_fasta == "al_and_unal"</filter> | |
| 97 </data> | |
| 98 <data format="fasta" label="Unmatched reads" name="unaligned"> | |
| 99 <filter>additional_fasta == "unal" or additional_fasta == "al_and_unal"</filter> | |
| 100 </data> | |
| 101 </outputs> | |
| 102 <tests> | |
| 103 <test> | |
| 104 <param name="genomeSource" value="history" /> | |
| 105 <param ftype="fasta" name="ownFile" value="297_reference.fa" /> | |
| 106 <param name="method" value="unique" /> | |
| 107 <param ftype="fasta" name="input" value="input.fa" /> | |
| 108 <param name="v_mismatches" value="1" /> | |
| 109 <param name="output_format" value="bam" /> | |
|
1
71b072cf5dde
planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
0
diff
changeset
|
110 <output file="output.bam" ftype="bam" compare="sim_size" delta="1000" name="output" /> |
| 0 | 111 </test> |
| 112 <test> | |
| 113 <param name="genomeSource" value="history" /> | |
| 114 <param ftype="fasta" name="ownFile" value="297_reference.fa" /> | |
| 115 <param name="method" value="unique" /> | |
| 116 <param ftype="fastq" name="input" value="input.fastq" /> | |
| 117 <param name="v_mismatches" value="1" /> | |
| 118 <param name="output_format" value="bam" /> | |
|
1
71b072cf5dde
planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
0
diff
changeset
|
119 <output file="output2.bam" ftype="bam" compare="sim_size" delta="1000" name="output" /> |
| 0 | 120 </test> |
| 121 </tests> | |
| 122 <help> | |
| 123 | |
| 124 **What it does** | |
| 125 | |
| 126 Bowtie_ is a short read aligner designed to be ultrafast and memory-efficient. It is developed by Ben Langmead and Cole Trapnell. Please cite: Langmead B, Trapnell C, Pop M, Salzberg SL. Ultrafast and memory-efficient alignment of short DNA sequences to the human genome. Genome Biology 10:R25. | |
| 127 | |
| 128 .. _Bowtie: http://bowtie-bio.sourceforge.net/index.shtml | |
| 129 | |
| 130 A generic "Map with Bowtie for Illumina" Galaxy tool is available in the main Galaxy distribution. | |
| 131 | |
| 132 However, this Bowtie wrapper tool only takes FASTQ files as inputs. | |
| 133 | |
| 134 The sRbowtie wrapper specifically works with short reads FASTA inputs (-v bowtie mode) | |
| 135 | |
| 136 ------ | |
| 137 | |
| 138 **OPTIONS** | |
| 139 | |
| 140 .. class:: infomark | |
| 141 | |
| 142 This script uses Bowtie to match reads on a reference index. | |
| 143 | |
| 144 Depending on the type of matching, different bowtie options are used: | |
| 145 | |
| 146 **Match on sense strand RNA reference index, multiple mappers randomly matched at a single position** | |
| 147 | |
| 148 Match on RNA reference, SENSE strand, randomly attributing multiple mapper to target with least mismatches, the polarity column is suppressed in the bowtie tabular report: | |
| 149 | |
| 150 *-v [0,1,2,3] -M 1 --best --strata -p 12 --norc --suppress 2,6,7,8* | |
| 151 | |
| 152 **Match unique mappers on DNA reference index** | |
| 153 | |
| 154 Match ONLY unique mappers on DNA reference index | |
| 155 | |
| 156 *-v [0,1,2,3] -m 1 -p 12 --suppress 6,7,8* | |
| 157 | |
| 158 Note that using this option with -v values other than 0 is questionnable... | |
| 159 | |
| 160 **Match on DNA, multiple mappers randomly matched at a single position** | |
| 161 | |
| 162 Match multiple mappers, randomly attributing multiple mapper to target with least mismatches, number of mismatch allowed specified by -v option: | |
| 163 | |
| 164 *-v [0,1,2,3] -M 1 --best --strata -p 12 --suppress 6,7,8* | |
| 165 | |
| 166 **Match on DNA as fast as possible, without taking care of mapping issues (for raw annotation of reads)** | |
| 167 | |
| 168 Match with highest speed, not guaranteeing best hit for speed gain: | |
| 169 | |
| 170 *-v [0,1,2,3] -k 1 --best -p 12 --suppress 6,7,8* | |
| 171 | |
| 172 | |
| 173 ----- | |
| 174 | |
| 175 **Input formats** | |
| 176 | |
| 177 .. class:: warningmark | |
| 178 | |
| 179 *The only accepted format for the script is a raw fasta list of reads, clipped from their adapter* | |
| 180 | |
| 181 ----- | |
| 182 | |
| 183 **OUTPUTS** | |
| 184 | |
| 185 If you choose tabular as the output format, you will obtain the matched reads in standard bowtie output format, having the following columns:: | |
| 186 | |
| 187 Column Description | |
| 188 -------- -------------------------------------------------------- | |
| 189 1 FastaID fasta identifier | |
| 190 2 polarity + or - depending whether the match was reported on the forward or reverse strand | |
| 191 3 target name of the matched target | |
| 192 4 Offset O-based coordinate of the miR on the miRBase pre-miR sequence | |
| 193 5 Seq sequence of the matched Read | |
| 194 | |
| 195 If you choose SAM, you will get the output in unordered SAM format. | |
| 196 | |
| 197 .. class:: warningmark | |
| 198 | |
| 199 if you choose BAM, the output will be in sorted BAM format. | |
| 200 To be viewable in Trackster, several condition must be fulfilled: | |
| 201 | |
| 202 .. class:: infomark | |
| 203 | |
| 204 Reads must have been matched to a genome whose chromosome names are compatible with Trackster genome indexes | |
| 205 | |
| 206 .. class:: infomark | |
| 207 | |
| 208 the database/Build (dbkey) which is indicated for the dataset (Pencil - Database/Build field) must match a Trackster genome index. | |
| 209 | |
| 210 Please contact the Galaxy instance administrator if your genome is not referenced | |
| 211 | |
| 212 **Matched and unmatched fasta reads can be retrieved, for further analyses** | |
| 213 | |
| 214 </help> | |
| 215 <citations> | |
| 216 <citation type="doi">10.1186/gb-2009-10-3-r25</citation> | |
| 217 </citations> | |
| 218 </tool> |