Mercurial > repos > pjbriggs > pal_finder
annotate pal_finder_wrapper.xml @ 14:3f8bf1a0403b draft
Uploaded version with bad primer ranger detection (WIP).
| author | pjbriggs |
|---|---|
| date | Thu, 22 Mar 2018 07:21:26 -0400 |
| parents | d26fb5260c67 |
| children | a3af1ff4cad1 |
| rev | line source |
|---|---|
|
14
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
1 <tool id="microsat_pal_finder" name="pal_finder" version="0.02.04.7"> |
| 3 | 2 <description>Find microsatellite repeat elements from sequencing reads and design PCR primers to amplify them</description> |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
3 <macros> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
4 <import>pal_finder_macros.xml</import> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
5 </macros> |
| 3 | 6 <requirements> |
| 7 <requirement type="package" version="0.02.04">pal_finder</requirement> | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
8 <requirement type="package" version="2.7">python</requirement> |
| 3 | 9 <requirement type="package" version="1.65">biopython</requirement> |
| 10 <requirement type="package" version="2.8.1">pandaseq</requirement> | |
| 11 </requirements> | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
12 <command><![CDATA[ |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
13 @CONDA_PAL_FINDER_SCRIPT_DIR@ && |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
14 @CONDA_PAL_FINDER_DATA_DIR@ && |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
15 bash $__tool_directory__/pal_finder_wrapper.sh |
| 0 | 16 #if str( $platform.platform_type ) == "illumina" |
| 3 | 17 #set $paired_input_type = $platform.paired_input_type_conditional.paired_input_type |
| 18 #if $paired_input_type == "pair_of_files" | |
| 19 "$platform.paired_input_type_conditional.input_fastq_r1" | |
| 20 "$platform.paired_input_type_conditional.input_fastq_r2" | |
| 21 #else | |
| 22 "$platform.paired_input_type_conditional.input_fastq_pair.forward" | |
| 23 "$platform.paired_input_type_conditional.input_fastq_pair.reverse" | |
| 24 #end if | |
| 0 | 25 #else |
| 3 | 26 --454 "$platform.input_fasta" |
| 0 | 27 #end if |
| 28 $output_microsat_summary $output_pal_summary | |
|
14
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
29 #if $report_bad_primer_ranges |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
30 --bad_primer_ranges "$output_bad_primer_read_ids" |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
31 #end if |
| 0 | 32 #if $keep_config_file |
| 3 | 33 --output_config_file "$output_config_file" |
| 0 | 34 #end if |
|
1
288a74cd7a8d
Explicitly build and use perl 5.16.3 as a tool dependency.
pjbriggs
parents:
0
diff
changeset
|
35 --primer-prefix "$primer_prefix" |
| 0 | 36 --2merMinReps $min_2mer_repeats |
| 37 --3merMinReps $min_3mer_repeats | |
| 38 --4merMinReps $min_4mer_repeats | |
| 39 --5merMinReps $min_5mer_repeats | |
| 40 --6merMinReps $min_6mer_repeats | |
| 41 #if str( $primer.primer_options ) == "custom" | |
| 42 --primer-opt-size $primer.primer_opt_size | |
| 43 --primer-min-size $primer.primer_min_size | |
| 44 --primer-max-size $primer.primer_max_size | |
| 45 --primer-min-gc $primer.primer_min_gc | |
| 46 --primer-max-gc $primer.primer_max_gc | |
| 47 --primer-gc-clamp $primer.primer_gc_clamp | |
| 48 --primer-max-end-gc $primer.primer_max_end_gc | |
| 49 --primer-min-tm $primer.primer_min_tm | |
| 50 --primer-max-tm $primer.primer_max_tm | |
| 51 --primer-opt-tm $primer.primer_opt_tm | |
| 52 --primer-pair-max-diff-tm $primer.primer_pair_max_diff_tm | |
| 53 #end if | |
| 54 #if str( $mispriming.mispriming_options ) == "custom" | |
| 55 --primer-mispriming-library $mispriming.mispriming_library | |
| 56 #end if | |
| 3 | 57 #if str( $platform.platform_type ) == "illumina" |
| 58 #if $platform.filters | |
| 59 #for $filter in str($platform.filters).split(',') | |
| 60 $filter | |
| 61 --filter_microsats "$output_filtered_microsats" | |
| 62 #end for | |
| 63 #end if | |
| 64 #if str( $platform.assembly ) == '-assembly' | |
| 65 $platform.assembly "$output_assembly" | |
| 66 #end if | |
| 67 #end if | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
68 ]]></command> |
| 0 | 69 <inputs> |
| 70 <param name="primer_prefix" type="text" value="test" size="25" label="Primer prefix" help="This prefix will be added to the beginning of all primer names" /> | |
| 71 <conditional name="platform"> | |
| 72 <param name="platform_type" type="select" label="Sequencing platform used to generate data" help="Currently pal_finder only handles Illumina paired-end reads and 454 single-end reads" > | |
| 73 <option value="illumina" selected="true">Illumina</option> | |
| 74 <option value="454">454</option> | |
| 75 </param> | |
| 76 <when value="illumina"> | |
| 3 | 77 <conditional name="paired_input_type_conditional"> |
| 78 <param name="paired_input_type" type="select" label="Input Type"> | |
| 79 <option value="pair_of_files" selected="true">Pair of datasets</option> | |
| 80 <option value="collection">Dataset collection pair</option> | |
| 81 </param> | |
| 82 <when value="pair_of_files"> | |
| 83 <param name="input_fastq_r1" type="data" format="fastqsanger" | |
| 84 label="Illumina fastq file (read 1)" /> | |
| 85 <param name="input_fastq_r2" type="data" format="fastqsanger" | |
| 86 label="Illumina fastq file (read 2)" /> | |
| 87 </when> | |
| 88 <when value="collection"> | |
| 89 <param name="input_fastq_pair" format="fastqsanger" | |
| 90 type="data_collection" collection_type="paired" | |
| 91 label="Select FASTQ dataset collection with R1/R2 pair" /> | |
| 92 </when> | |
| 93 </conditional> | |
| 94 <param name="filters" type="select" display="checkboxes" | |
| 95 multiple="True" label="Filters to apply to the pal_finder results" | |
| 96 help="Apply none, one or more filters to refine results"> | |
| 97 <option value="-primers" selected="True">Only include loci with designed primers</option> | |
| 98 <option value="-occurrences" selected="True">Exclude loci where the primer sequences occur more than once in the reads</option> | |
| 99 <option value="-rankmotifs" selected="True">Only include loci with 'perfect' motifs, and rank by motif size</option> | |
| 100 </param> | |
| 101 <param name="assembly" type="boolean" | |
| 102 checked="True" truevalue="-assembly" falsevalue="" | |
| 103 label="Use PANDAseq to assemble paired-end reads and confirm primer sequences are present in high-quality assembly" /> | |
| 0 | 104 </when> |
| 105 <when value="454"> | |
| 106 <param name="input_fasta" type="data" format="fasta" label="454 fasta file with raw reads" /> | |
| 107 </when> | |
| 108 </conditional> | |
| 109 <param name="min_2mer_repeats" type="integer" value="6" label="Minimum number of 2-mer repeat units to detect" help="Set to zero to ignore repeats of this n-mer unit" /> | |
| 110 <param name="min_3mer_repeats" type="integer" value="0" label="Minimum number of 3-mer repeat units" help="Set to zero to ignore repeats of this n-mer unit" /> | |
| 111 <param name="min_4mer_repeats" type="integer" value="0" label="Minimum number of 4-mer repeat units" help="Set to zero to ignore repeats of this n-mer unit" /> | |
| 112 <param name="min_5mer_repeats" type="integer" value="0" label="Minimum number of 5-mer repeat units" help="Set to zero to ignore repeats of this n-mer unit" /> | |
| 113 <param name="min_6mer_repeats" type="integer" value="0" label="Minimum number of 6-mer repeat units" help="Set to zero to ignore repeats of this n-mer unit" /> | |
| 114 <conditional name="mispriming"> | |
| 115 <param name="mispriming_options" type="select" label="Mispriming library to use" help="Specify file of nucleotide sequences to avoid amplifying (PRIMER_MISPRIMING_LIBRARY)"> | |
| 116 <option value="default">Default from pal_finder</option> | |
| 117 <option value="custom">Custom sequences from history</option> | |
| 118 </param> | |
| 119 <when value="default"> | |
| 120 </when> | |
| 121 <when value="custom"> | |
| 122 <param name="mispriming_library" type="data" format="fasta" label="Select mispriming library from history" help="Fasta file containing sequences to avoid amplifying" /> | |
| 123 </when> | |
| 124 </conditional> | |
| 125 <conditional name="primer"> | |
| 126 <param name="primer_options" type="select" label="Primer settings to use" help="Advanced users can customise the settings for primer3 for more control"> | |
| 127 <option value="default">Defaults for pal_finder</option> | |
| 128 <option value="custom">Custom</option> | |
| 129 </param> | |
| 130 <when value="custom"> | |
| 131 <param name="primer_opt_size" type="integer" value="20" | |
| 132 label="Optimum length (in bases) of a primer (PRIMER_OPT_SIZE)" | |
| 133 help="Primer3 will attempt to pick primers close to this length" /> | |
| 134 <param name="primer_min_size" type="integer" value="18" | |
| 135 label="Minimum acceptable length (in bases) of a primer (PRIMER_MIN_SIZE)" | |
| 136 help="Must be greater than 0 and less than or equal to PRIMER_MAX_SIZE" /> | |
| 137 <param name="primer_max_size" type="integer" value="30" | |
| 138 label="Maximum acceptable length (in bases) of a primer (PRIMER_MAX_SIZE)" | |
| 139 help="Currently this parameter cannot be larger than 35. This limit is governed by maximum oligo size for which primer3's melting-temperature is valid" /> | |
| 140 <param name="primer_min_gc" type="float" value="30.0" | |
| 141 label="Minimum allowable percentage of Gs and Cs in any primer (PRIMER_MIN_GC)" /> | |
| 142 <param name="primer_max_gc" type="float" value="80.0" | |
| 143 label="Maximum allowable percentage of Gs and Cs in any primer (PRIMER_MAX_GC)" /> | |
| 144 <param name="primer_gc_clamp" type="integer" value="2" | |
| 145 label="Specify number of consecutive Gs and Cs at 3' end of both the left and right primer (PRIMER_GC_CLAMP)" /> | |
| 146 <param name="primer_max_end_gc" type="integer" value="5" | |
| 147 label="Maximum number of Gs or Cs allowed in last five 3' bases of a left or right primer (PRIMER_MAX_END_GC)" /> | |
| 148 <param name="primer_min_tm" type="float" value="58.0" | |
| 149 label="Minimum acceptable melting temperature for a primer oligo (PRIMER_MIN_TM)" | |
| 150 help="Temperature should be in degrees Celsius" /> | |
| 151 <param name="primer_max_tm" type="float" value="65.0" | |
| 152 label="Maximum acceptable melting temperature for a primer oligo (PRIMER_MAX_TM)" | |
| 153 help="Temperature should be in degrees Celsius" /> | |
| 154 <param name="primer_opt_tm" type="float" value="62.0" | |
| 155 label="Optimum melting temperature for a primer (PRIMER_OPT_TM)" | |
| 156 help="Temperature should be in degrees Celsius" /> | |
| 157 <param name="primer_pair_max_diff_tm" type="float" value="2.0" | |
| 158 label="Maximum acceptable difference between melting temperatures of left and right primers (PRIMER_PAIR_MAX_DIFF_TM)" | |
| 159 help="Temperature should be in degrees Celsius" /> | |
| 160 </when> | |
| 161 </conditional> | |
|
14
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
162 <param name="report_bad_primer_ranges" type="boolean" truevalue="True" falsevalue="False" label="Output IDs for input reads which generate bad primer ranges" help="Can be used to screen input Fastqs" /> |
| 0 | 163 <param name="keep_config_file" type="boolean" truevalue="True" falsevalue="False" |
| 164 label="Output the config file to the history" | |
| 165 help="Can be used to run pal_finder outside of Galaxy" /> | |
| 166 </inputs> | |
| 167 <outputs> | |
| 3 | 168 <data name="output_pal_summary" format="tabular" label="${tool.name} on ${on_string} for ${primer_prefix}: all microsatellites (full details)" /> |
| 169 <data name="output_filtered_microsats" format="tabular" label="${tool.name} on ${on_string} for ${primer_prefix}: filtered microsatellites (full details)"> | |
| 170 <filter>platform['platform_type'] == 'illumina' and platform['filters'] is not None</filter> | |
| 0 | 171 </data> |
| 3 | 172 <data name="output_microsat_summary" format="txt" label="${tool.name} on ${on_string} for ${primer_prefix}: summary of microsatellite types" /> |
| 173 <data name="output_assembly" format="tabular" label="${tool.name} on ${on_string} for ${primer_prefix}: assembly"> | |
| 174 <filter>platform['assembly'] is True</filter> | |
| 175 </data> | |
|
14
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
176 <data name="output_bad_primer_read_ids" format="tabular" label="${tool.name} on ${on_string} for ${primer_prefix}: read IDs generating bad primer ranges"> |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
177 <filter>report_bad_primer_ranges is True</filter> |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
178 </data> |
| 3 | 179 <data name="output_config_file" format="txt" label="${tool.name} on ${on_string} for ${primer_prefix}: config file"> |
| 0 | 180 <filter>keep_config_file is True</filter> |
| 181 </data> | |
| 182 </outputs> | |
| 183 <tests> | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
184 <!-- Test with Illumina input --> |
| 0 | 185 <test> |
| 186 <param name="platform_type" value="illumina" /> | |
| 187 <param name="input_fastq_r1" value="illuminaPE_r1.fq" ftype="fastqsanger" /> | |
| 188 <param name="input_fastq_r2" value="illuminaPE_r2.fq" ftype="fastqsanger" /> | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
189 <expand macro="output_illumina_microsat_summary" /> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
190 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats.out.re_match" /> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
191 <output name="output_filtered_microsats" compare="re_match" file="illuminaPE_filtered_microsats.out.re_match" /> |
| 3 | 192 <output name="output_assembly" file="illuminaPE_assembly_after_filters.out" /> |
| 193 </test> | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
194 <!-- Test with Illumina input as dataset pair --> |
| 3 | 195 <test> |
| 196 <param name="platform_type" value="illumina" /> | |
| 197 <param name="paired_input_type" value="collection" /> | |
| 198 <param name="input_fastq_pair"> | |
| 199 <collection type="paired"> | |
| 200 <element name="forward" value="illuminaPE_r1.fq" ftype="fastqsanger" /> | |
| 201 <element name="reverse" value="illuminaPE_r2.fq" ftype="fastqsanger" /> | |
| 202 </collection> | |
| 203 </param> | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
204 <expand macro="output_illumina_microsat_summary" /> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
205 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats.out.re_match" /> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
206 <output name="output_filtered_microsats" compare="re_match" file="illuminaPE_filtered_microsats.out.re_match" /> |
| 3 | 207 <output name="output_assembly" file="illuminaPE_assembly_after_filters.out" /> |
| 208 </test> | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
209 <!-- Test with Illumina input filter to loci with PandaSEQ assembly |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
210 ('-assembly' option) |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
211 --> |
| 3 | 212 <test> |
| 213 <param name="platform_type" value="illumina" /> | |
| 214 <param name="filters" value="" /> | |
| 215 <param name="input_fastq_r1" value="illuminaPE_r1.fq" ftype="fastqsanger" /> | |
| 216 <param name="input_fastq_r2" value="illuminaPE_r2.fq" ftype="fastqsanger" /> | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
217 <expand macro="output_illumina_microsat_summary" /> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
218 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats.out.re_match" /> |
| 3 | 219 <output name="output_assembly" file="illuminaPE_assembly.out" /> |
| 220 </test> | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
221 <!-- Test with Illumina input filter to loci with primers |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
222 ('-primers' option) --> |
| 3 | 223 <test> |
| 224 <param name="platform_type" value="illumina" /> | |
| 225 <param name="filters" value="-primers" /> | |
| 226 <param name="assembly" value="false" /> | |
| 227 <param name="input_fastq_r1" value="illuminaPE_r1.fq" ftype="fastqsanger" /> | |
| 228 <param name="input_fastq_r2" value="illuminaPE_r2.fq" ftype="fastqsanger" /> | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
229 <expand macro="output_illumina_microsat_summary" /> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
230 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats.out.re_match" /> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
231 <output name="output_filtered_microsats" compare="re_match" file="illuminaPE_filtered_microsats_primers.out.re_match" /> |
| 3 | 232 </test> |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
233 <!-- Test with Illumina input filter to loci which appear only once |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
234 ('-occurrences' option) --> |
| 3 | 235 <test> |
| 236 <param name="platform_type" value="illumina" /> | |
| 237 <param name="filters" value="-occurrences" /> | |
| 238 <param name="assembly" value="false" /> | |
| 239 <param name="input_fastq_r1" value="illuminaPE_r1.fq" ftype="fastqsanger" /> | |
| 240 <param name="input_fastq_r2" value="illuminaPE_r2.fq" ftype="fastqsanger" /> | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
241 <expand macro="output_illumina_microsat_summary" /> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
242 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats.out.re_match" /> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
243 <output name="output_filtered_microsats" compare="re_match" file="illuminaPE_filtered_microsats_occurrences.out.re_match" /> |
| 3 | 244 </test> |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
245 <!-- Test with Illumina input filter and rank loci with perfect motifs |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
246 ('-rankmotifs' option) --> |
| 3 | 247 <test> |
| 248 <param name="platform_type" value="illumina" /> | |
| 249 <param name="filters" value="-rankmotifs" /> | |
| 250 <param name="assembly" value="false" /> | |
| 251 <param name="input_fastq_r1" value="illuminaPE_r1.fq" ftype="fastqsanger" /> | |
| 252 <param name="input_fastq_r2" value="illuminaPE_r2.fq" ftype="fastqsanger" /> | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
253 <expand macro="output_illumina_microsat_summary" /> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
254 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats.out.re_match" /> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
255 <output name="output_filtered_microsats" compare="re_match" file="illuminaPE_filtered_microsats_rankmotifs.out.re_match" /> |
| 0 | 256 </test> |
|
14
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
257 <!-- Test with Illumina input generating bad primer ranges |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
258 --> |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
259 <test> |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
260 <param name="platform_type" value="illumina" /> |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
261 <param name="filters" value="" /> |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
262 <param name="assembly" value="false" /> |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
263 <param name="input_fastq_r1" value="illuminaPE_r1.fq" ftype="fastqsanger" /> |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
264 <param name="input_fastq_r2" value="illuminaPE_r2.fq" ftype="fastqsanger" /> |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
265 <param name="output_bad_primer_read_ids" value="true" /> |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
266 <expand macro="output_illumina_microsat_summary" /> |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
267 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats.out.re_match" /> |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
268 <output name="output_bad_primer_read_ids" file="illuminaPE_bad_primer_ids.out" /> |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
269 </test> |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
270 <!-- Test with 454 input --> |
| 0 | 271 <test> |
| 272 <param name="platform_type" value="454" /> | |
| 273 <param name="input_fasta" value="454_in.fa" ftype="fasta" /> | |
|
12
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
274 <expand macro="output_454_microsat_summary" /> |
|
d26fb5260c67
0.02.04.6: update to use conda to resolve dependencies.
pjbriggs
parents:
11
diff
changeset
|
275 <output name="output_pal_summary" compare="re_match" file="454_microsats.out.re_match" /> |
| 0 | 276 </test> |
| 277 </tests> | |
| 278 <help> | |
| 279 .. class:: infomark | |
| 280 | |
| 281 **What it does** | |
| 282 | |
| 283 This tool runs the pal_finder program, which finds microsatellite repeat elements | |
| 284 directly from raw 454 or Illumina paired-end sequencing reads. It then designs PCR | |
| 285 primers to amplify these repeat loci (Potentially Amplifiable Loci: PAL). | |
| 286 | |
| 3 | 287 Optionally for Illumina data, one or more filters can be applied to the output from |
| 288 pal_finder to: | |
| 289 | |
| 290 * Only include loci with designed primers | |
| 291 * Exclude loci where the primer sequences occur more than once in the reads | |
| 292 * Only include loci with 'perfect' motifs (and rank by motif size,largest to | |
| 293 smallest) | |
| 294 * Use PANDAseq to assemble paired-end reads and confirm primer sequences are | |
| 295 present in high-quality assembly | |
| 0 | 296 |
| 297 Pal_finder runs the primer3_core program; information on the settings used in | |
| 298 primer3_core can be found in the Primer3 manual at | |
| 299 http://primer3.sourceforge.net/primer3_manual.htm | |
| 300 | |
| 301 ------------- | |
| 302 | |
|
14
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
303 .. class:: warning |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
304 |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
305 **Known problems** |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
306 |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
307 .. class:: infomark |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
308 |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
309 **Bad primer product size ranges** |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
310 |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
311 For some datasets pal_finder may generate 'bad' product size ranges (where the |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
312 lower limit exceeds the upper limit) for one or more reads, for input into |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
313 primer3_core. |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
314 |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
315 If this occurs then the tool will terminate with an error. A list of the reads |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
316 for which the bad ranges were generated can be found in the error message |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
317 which can be accessed via the 'bug' icon from a failed dataset. |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
318 |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
319 The conditions which cause this error are unclear. However we believe it to be |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
320 associated with short or low quality reads. It is recommended that the input |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
321 data are sufficiently trimmed and filtered (using e.g. the Trimmomatic tool) |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
322 before rerunning pal_finder. |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
323 |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
324 ------------- |
|
3f8bf1a0403b
Uploaded version with bad primer ranger detection (WIP).
pjbriggs
parents:
12
diff
changeset
|
325 |
| 0 | 326 .. class:: infomark |
| 327 | |
| 328 **Credits** | |
| 329 | |
| 330 This Galaxy tool has been developed by Peter Briggs within the Bioinformatics Core | |
| 331 Facility at the University of Manchester. It runs the pal_finder package which can be | |
| 332 obtained from http://sourceforge.net/projects/palfinder/: | |
| 333 | |
| 334 * PLoS One. 2012; 7(2): e30953 "Rapid Microsatellite Identification from Illumina Paired-End | |
| 335 Genomic Sequencing in Two Birds and a Snake" Todd A. Castoe, Alexander W. Poole, A. P. | |
| 336 Jason de Koning, Kenneth L. Jones, Diana F. Tomback, Sara J. Oyler-McCance, Jennifer A. | |
| 337 Fike, Stacey L. Lance, Jeffrey W. Streicher, Eric N. Smith, and David D. Pollock | |
| 338 | |
| 339 The paper is available at http://www.ncbi.nlm.nih.gov/pmc/articles/PMC3279355/ | |
| 340 | |
| 341 This tool is compatible with pal_finder version 0.02.04, which in turn runs the | |
| 342 primer3_core program (version 2.0.0-alpha is required, available from | |
| 343 http://primer3.sourceforge.net/releases.php): | |
| 344 | |
| 345 * Steve Rozen and Helen J. Skaletsky (2000) "Primer3 on the WWW for general users and for | |
| 346 biologist programmers". In: Krawetz S, Misener S (eds) Bioinformatics Methods and | |
| 347 Protocols: Methods in Molecular Biology. Humana Press, Totowa, NJ, pp 365-386 | |
| 348 | |
| 349 The paper is available at | |
| 350 http://purl.com/STEVEROZEN/papers/rozen-and-skaletsky-2000-primer3.pdf | |
| 351 | |
| 3 | 352 The filtering and assembly of the pal_finder output for Illumina data is performed |
| 353 using a Python utility written by Graeme Fox at the University of Manchester, and which | |
| 354 is included with this tool; this utility uses the BioPython and PANDAseq packages. | |
| 0 | 355 |
| 356 Please kindly acknowledge both this Galaxy tool, the pal_finder and primer3 packages, and | |
| 3 | 357 the utility script and its dependencies if you use it in your work. |
| 0 | 358 </help> |
| 359 <citations> | |
| 360 <!-- | |
| 361 See https://wiki.galaxyproject.org/Admin/Tools/ToolConfigSyntax#A.3Ccitations.3E_tag_set | |
| 362 Can be either DOI or Bibtex | |
| 363 Use http://www.bioinformatics.org/texmed/ to convert PubMed to Bibtex | |
| 364 --> | |
| 365 <citation type="doi">10.1371/journal.pone.0030953</citation> | |
| 366 <citation type="bibtex">@Article{pmid10547847, | |
| 3 | 367 Author="Rozen, S. and Skaletsky, H. ", |
| 0 | 368 Title="{{P}rimer3 on the {W}{W}{W} for general users and for biologist programmers}", |
| 369 Journal="Methods Mol. Biol.", | |
| 370 Year="2000", | |
| 371 Volume="132", | |
| 372 Pages="365--386", | |
| 373 URL="{http://purl.com/STEVEROZEN/papers/rozen-and-skaletsky-2000-primer3.pdf}" | |
| 374 }</citation> | |
| 3 | 375 <citation type="doi">10.1093/bioinformatics/btp163</citation> |
| 376 <citation type="doi">10.1186/1471-2105-13-31</citation> | |
| 0 | 377 </citations> |
| 378 </tool> |