annotate pal_finder_wrapper.xml @ 9:52dbe2089d14 draft default tip

Version 0.02.04.8 (update fastq subsetting).
author pjbriggs
date Wed, 04 Jul 2018 06:05:52 -0400
parents 4e625d3672ba
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
52dbe2089d14 Version 0.02.04.8 (update fastq subsetting).
pjbriggs
parents: 8
diff changeset
1 <tool id="microsat_pal_finder" name="pal_finder" version="0.02.04.8">
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
2 <description>Find microsatellite repeat elements from sequencing reads and design PCR primers to amplify them</description>
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
3 <macros>
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
4 <import>pal_finder_macros.xml</import>
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
5 </macros>
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
6 <requirements>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
7 <requirement type="package" version="0.02.04">pal_finder</requirement>
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
8 <requirement type="package" version="2.7">python</requirement>
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
9 <requirement type="package" version="1.65">biopython</requirement>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
10 <requirement type="package" version="2.8.1">pandaseq</requirement>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
11 </requirements>
8
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
12 <command detect_errors="exit_code"><![CDATA[
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
13 @CONDA_PAL_FINDER_SCRIPT_DIR@ &&
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
14 @CONDA_PAL_FINDER_DATA_DIR@ &&
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
15 bash $__tool_directory__/pal_finder_wrapper.sh
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
16 #if str( $platform.platform_type ) == "illumina"
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
17 #set $paired_input_type = $platform.paired_input_type_conditional.paired_input_type
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
18 #if $paired_input_type == "pair_of_files"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
19 "$platform.paired_input_type_conditional.input_fastq_r1"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
20 "$platform.paired_input_type_conditional.input_fastq_r2"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
21 #else
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
22 "$platform.paired_input_type_conditional.input_fastq_pair.forward"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
23 "$platform.paired_input_type_conditional.input_fastq_pair.reverse"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
24 #end if
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
25 #else
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
26 --454 "$platform.input_fasta"
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
27 #end if
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
28 $output_microsat_summary $output_pal_summary
8
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
29 #if $report_bad_primer_ranges
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
30 --bad_primer_ranges "$output_bad_primer_read_ids"
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
31 #end if
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
32 #if $keep_config_file
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
33 --output_config_file "$output_config_file"
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
34 #end if
1
771ebe02636f Uploaded version 0.02.04.2: fix bug that causes tool to fail when prefix includes spaces; add explicit dependency on Perl 5.16.3.
pjbriggs
parents: 0
diff changeset
35 --primer-prefix "$primer_prefix"
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
36 --2merMinReps $min_2mer_repeats
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
37 --3merMinReps $min_3mer_repeats
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
38 --4merMinReps $min_4mer_repeats
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
39 --5merMinReps $min_5mer_repeats
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
40 --6merMinReps $min_6mer_repeats
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
41 #if str( $primer.primer_options ) == "custom"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
42 --primer-opt-size $primer.primer_opt_size
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
43 --primer-min-size $primer.primer_min_size
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
44 --primer-max-size $primer.primer_max_size
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
45 --primer-min-gc $primer.primer_min_gc
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
46 --primer-max-gc $primer.primer_max_gc
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
47 --primer-gc-clamp $primer.primer_gc_clamp
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
48 --primer-max-end-gc $primer.primer_max_end_gc
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
49 --primer-min-tm $primer.primer_min_tm
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
50 --primer-max-tm $primer.primer_max_tm
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
51 --primer-opt-tm $primer.primer_opt_tm
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
52 --primer-pair-max-diff-tm $primer.primer_pair_max_diff_tm
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
53 #end if
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
54 #if str( $mispriming.mispriming_options ) == "custom"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
55 --primer-mispriming-library $mispriming.mispriming_library
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
56 #end if
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
57 #if str( $platform.platform_type ) == "illumina"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
58 #if $platform.filters
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
59 #for $filter in str($platform.filters).split(',')
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
60 $filter
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
61 --filter_microsats "$output_filtered_microsats"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
62 #end for
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
63 #end if
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
64 #if str( $platform.assembly ) == '-assembly'
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
65 $platform.assembly "$output_assembly"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
66 #end if
8
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
67 #set $use_all_reads = $platform.subset_conditional.use_all_reads
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
68 #if str( $use_all_reads ) != "yes"
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
69 --subset "$platform.subset_conditional.subset"
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
70 #end if
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
71 #end if
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
72 ]]></command>
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
73 <inputs>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
74 <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" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
75 <conditional name="platform">
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
76 <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" >
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
77 <option value="illumina" selected="true">Illumina</option>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
78 <option value="454">454</option>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
79 </param>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
80 <when value="illumina">
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
81 <conditional name="paired_input_type_conditional">
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
82 <param name="paired_input_type" type="select" label="Input Type">
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
83 <option value="pair_of_files" selected="true">Pair of datasets</option>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
84 <option value="collection">Dataset collection pair</option>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
85 </param>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
86 <when value="pair_of_files">
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
87 <param name="input_fastq_r1" type="data" format="fastqsanger"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
88 label="Illumina fastq file (read 1)" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
89 <param name="input_fastq_r2" type="data" format="fastqsanger"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
90 label="Illumina fastq file (read 2)" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
91 </when>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
92 <when value="collection">
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
93 <param name="input_fastq_pair" format="fastqsanger"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
94 type="data_collection" collection_type="paired"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
95 label="Select FASTQ dataset collection with R1/R2 pair" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
96 </when>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
97 </conditional>
8
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
98 <conditional name="subset_conditional">
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
99 <param name="use_all_reads" type="boolean" label="Use all reads for microsatellite detection?" checked="True" truevalue="yes" falsevalue="no" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
100 <when value="no">
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
101 <param name="subset" type="text" value="0.5" label="Number or fraction of reads to use" help="Either an integer number of reads or a decimal fraction (e.g. 0.5 to select 50% of reads)" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
102 </when>
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
103 <when value="yes" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
104 </conditional>
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
105 <param name="filters" type="select" display="checkboxes"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
106 multiple="True" label="Filters to apply to the pal_finder results"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
107 help="Apply none, one or more filters to refine results">
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
108 <option value="-primers" selected="True">Only include loci with designed primers</option>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
109 <option value="-occurrences" selected="True">Exclude loci where the primer sequences occur more than once in the reads</option>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
110 <option value="-rankmotifs" selected="True">Only include loci with 'perfect' motifs, and rank by motif size</option>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
111 </param>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
112 <param name="assembly" type="boolean"
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
113 checked="True" truevalue="-assembly" falsevalue=""
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
114 label="Use PANDAseq to assemble paired-end reads and confirm primer sequences are present in high-quality assembly" />
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
115 </when>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
116 <when value="454">
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
117 <param name="input_fasta" type="data" format="fasta" label="454 fasta file with raw reads" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
118 </when>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
119 </conditional>
8
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
120 <param name="min_2mer_repeats" type="integer" value="6" label="Minimum number of 2-mer repeat units to detect" min="1" help="Must detect at least one repeat of this n-mer unit" />
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
121 <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" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
122 <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" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
123 <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" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
124 <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" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
125 <conditional name="mispriming">
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
126 <param name="mispriming_options" type="select" label="Mispriming library to use" help="Specify file of nucleotide sequences to avoid amplifying (PRIMER_MISPRIMING_LIBRARY)">
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
127 <option value="default">Default from pal_finder</option>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
128 <option value="custom">Custom sequences from history</option>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
129 </param>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
130 <when value="default">
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
131 </when>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
132 <when value="custom">
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
133 <param name="mispriming_library" type="data" format="fasta" label="Select mispriming library from history" help="Fasta file containing sequences to avoid amplifying" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
134 </when>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
135 </conditional>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
136 <conditional name="primer">
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
137 <param name="primer_options" type="select" label="Primer settings to use" help="Advanced users can customise the settings for primer3 for more control">
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
138 <option value="default">Defaults for pal_finder</option>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
139 <option value="custom">Custom</option>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
140 </param>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
141 <when value="custom">
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
142 <param name="primer_opt_size" type="integer" value="20"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
143 label="Optimum length (in bases) of a primer (PRIMER_OPT_SIZE)"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
144 help="Primer3 will attempt to pick primers close to this length" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
145 <param name="primer_min_size" type="integer" value="18"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
146 label="Minimum acceptable length (in bases) of a primer (PRIMER_MIN_SIZE)"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
147 help="Must be greater than 0 and less than or equal to PRIMER_MAX_SIZE" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
148 <param name="primer_max_size" type="integer" value="30"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
149 label="Maximum acceptable length (in bases) of a primer (PRIMER_MAX_SIZE)"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
150 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" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
151 <param name="primer_min_gc" type="float" value="30.0"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
152 label="Minimum allowable percentage of Gs and Cs in any primer (PRIMER_MIN_GC)" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
153 <param name="primer_max_gc" type="float" value="80.0"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
154 label="Maximum allowable percentage of Gs and Cs in any primer (PRIMER_MAX_GC)" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
155 <param name="primer_gc_clamp" type="integer" value="2"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
156 label="Specify number of consecutive Gs and Cs at 3' end of both the left and right primer (PRIMER_GC_CLAMP)" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
157 <param name="primer_max_end_gc" type="integer" value="5"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
158 label="Maximum number of Gs or Cs allowed in last five 3' bases of a left or right primer (PRIMER_MAX_END_GC)" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
159 <param name="primer_min_tm" type="float" value="58.0"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
160 label="Minimum acceptable melting temperature for a primer oligo (PRIMER_MIN_TM)"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
161 help="Temperature should be in degrees Celsius" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
162 <param name="primer_max_tm" type="float" value="65.0"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
163 label="Maximum acceptable melting temperature for a primer oligo (PRIMER_MAX_TM)"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
164 help="Temperature should be in degrees Celsius" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
165 <param name="primer_opt_tm" type="float" value="62.0"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
166 label="Optimum melting temperature for a primer (PRIMER_OPT_TM)"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
167 help="Temperature should be in degrees Celsius" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
168 <param name="primer_pair_max_diff_tm" type="float" value="2.0"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
169 label="Maximum acceptable difference between melting temperatures of left and right primers (PRIMER_PAIR_MAX_DIFF_TM)"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
170 help="Temperature should be in degrees Celsius" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
171 </when>
8
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
172 <when value="default" />
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
173 </conditional>
8
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
174 <param name="report_bad_primer_ranges" type="boolean" truevalue="True" falsevalue="False" label="Output IDs for input reads which generate bad primer product size ranges" help="Can be used to screen reads in input Fastqs " />
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
175 <param name="keep_config_file" type="boolean" truevalue="True" falsevalue="False"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
176 label="Output the config file to the history"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
177 help="Can be used to run pal_finder outside of Galaxy" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
178 </inputs>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
179 <outputs>
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
180 <data name="output_pal_summary" format="tabular" label="${tool.name} on ${on_string} for ${primer_prefix}: all microsatellites (full details)" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
181 <data name="output_filtered_microsats" format="tabular" label="${tool.name} on ${on_string} for ${primer_prefix}: filtered microsatellites (full details)">
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
182 <filter>platform['platform_type'] == 'illumina' and platform['filters'] is not None</filter>
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
183 </data>
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
184 <data name="output_microsat_summary" format="txt" label="${tool.name} on ${on_string} for ${primer_prefix}: summary of microsatellite types" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
185 <data name="output_assembly" format="tabular" label="${tool.name} on ${on_string} for ${primer_prefix}: assembly">
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
186 <filter>platform['assembly'] is True</filter>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
187 </data>
8
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
188 <data name="output_bad_primer_read_ids" format="tabular" label="${tool.name} on ${on_string} for ${primer_prefix}: read IDs generating bad primer ranges">
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
189 <filter>report_bad_primer_ranges is True</filter>
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
190 </data>
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
191 <data name="output_config_file" format="txt" label="${tool.name} on ${on_string} for ${primer_prefix}: config file">
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
192 <filter>keep_config_file is True</filter>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
193 </data>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
194 </outputs>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
195 <tests>
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
196 <!-- Test with Illumina input -->
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
197 <test>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
198 <param name="platform_type" value="illumina" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
199 <param name="input_fastq_r1" value="illuminaPE_r1.fq" ftype="fastqsanger" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
200 <param name="input_fastq_r2" value="illuminaPE_r2.fq" ftype="fastqsanger" />
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
201 <expand macro="output_illumina_microsat_summary" />
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
202 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats.out.re_match" />
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
203 <output name="output_filtered_microsats" compare="re_match" file="illuminaPE_filtered_microsats.out.re_match" />
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
204 <output name="output_assembly" file="illuminaPE_assembly_after_filters.out" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
205 </test>
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
206 <!-- Test with Illumina input as dataset pair -->
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
207 <test>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
208 <param name="platform_type" value="illumina" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
209 <param name="paired_input_type" value="collection" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
210 <param name="input_fastq_pair">
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
211 <collection type="paired">
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
212 <element name="forward" value="illuminaPE_r1.fq" ftype="fastqsanger" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
213 <element name="reverse" value="illuminaPE_r2.fq" ftype="fastqsanger" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
214 </collection>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
215 </param>
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
216 <expand macro="output_illumina_microsat_summary" />
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
217 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats.out.re_match" />
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
218 <output name="output_filtered_microsats" compare="re_match" file="illuminaPE_filtered_microsats.out.re_match" />
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
219 <output name="output_assembly" file="illuminaPE_assembly_after_filters.out" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
220 </test>
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
221 <!-- Test with Illumina input filter to loci with PandaSEQ assembly
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
222 ('-assembly' option)
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
223 -->
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
224 <test>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
225 <param name="platform_type" value="illumina" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
226 <param name="filters" value="" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
227 <param name="input_fastq_r1" value="illuminaPE_r1.fq" ftype="fastqsanger" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
228 <param name="input_fastq_r2" value="illuminaPE_r2.fq" ftype="fastqsanger" />
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
229 <expand macro="output_illumina_microsat_summary" />
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
230 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats.out.re_match" />
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
231 <output name="output_assembly" file="illuminaPE_assembly.out" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
232 </test>
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
233 <!-- Test with Illumina input filter to loci with primers
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
234 ('-primers' option) -->
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
235 <test>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
236 <param name="platform_type" value="illumina" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
237 <param name="filters" value="-primers" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
238 <param name="assembly" value="false" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
239 <param name="input_fastq_r1" value="illuminaPE_r1.fq" ftype="fastqsanger" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
240 <param name="input_fastq_r2" value="illuminaPE_r2.fq" ftype="fastqsanger" />
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
241 <expand macro="output_illumina_microsat_summary" />
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
242 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats.out.re_match" />
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
243 <output name="output_filtered_microsats" compare="re_match" file="illuminaPE_filtered_microsats_primers.out.re_match" />
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
244 </test>
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
245 <!-- Test with Illumina input filter to loci which appear only once
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
246 ('-occurrences' option) -->
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
247 <test>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
248 <param name="platform_type" value="illumina" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
249 <param name="filters" value="-occurrences" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
250 <param name="assembly" value="false" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
251 <param name="input_fastq_r1" value="illuminaPE_r1.fq" ftype="fastqsanger" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
252 <param name="input_fastq_r2" value="illuminaPE_r2.fq" ftype="fastqsanger" />
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
253 <expand macro="output_illumina_microsat_summary" />
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
254 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats.out.re_match" />
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
255 <output name="output_filtered_microsats" compare="re_match" file="illuminaPE_filtered_microsats_occurrences.out.re_match" />
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
256 </test>
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
257 <!-- Test with Illumina input filter and rank loci with perfect motifs
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
258 ('-rankmotifs' option) -->
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
259 <test>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
260 <param name="platform_type" value="illumina" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
261 <param name="filters" value="-rankmotifs" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
262 <param name="assembly" value="false" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
263 <param name="input_fastq_r1" value="illuminaPE_r1.fq" ftype="fastqsanger" />
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
264 <param name="input_fastq_r2" value="illuminaPE_r2.fq" ftype="fastqsanger" />
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
265 <expand macro="output_illumina_microsat_summary" />
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
266 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats.out.re_match" />
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
267 <output name="output_filtered_microsats" compare="re_match" file="illuminaPE_filtered_microsats_rankmotifs.out.re_match" />
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
268 </test>
8
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
269 <!-- Test with Illumina input using subset of reads -->
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
270 <test>
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
271 <param name="platform_type" value="illumina" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
272 <param name="filters" value="" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
273 <param name="assembly" value="false" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
274 <param name="use_all_reads" value="no" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
275 <param name="subset" value="0.5" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
276 <param name="input_fastq_r1" value="illuminaPE_r1.fq" ftype="fastqsanger" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
277 <param name="input_fastq_r2" value="illuminaPE_r2.fq" ftype="fastqsanger" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
278 <expand macro="output_illumina_microsat_subset_summary" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
279 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats_subset.out.re_match" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
280 </test>
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
281 <!-- Test with Illumina input filter that doesn't find any
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
282 microsatellites -->
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
283 <test expect_failure="true">
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
284 <param name="platform_type" value="illumina" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
285 <param name="filters" value="" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
286 <param name="assembly" value="false" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
287 <param name="min_2mer_repeats" value="8" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
288 <param name="input_fastq_r1" value="illuminaPE_r1_no_microsats.fq" ftype="fastqsanger" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
289 <param name="input_fastq_r2" value="illuminaPE_r2_no_microsats.fq" ftype="fastqsanger" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
290 <assert_stderr>
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
291 <has_text text="pal_finder failed to locate any microsatellites" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
292 </assert_stderr>
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
293 </test>
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
294 <!-- Test with Illumina input generating bad ranges -->
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
295 <test>
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
296 <param name="platform_type" value="illumina" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
297 <param name="filters" value="" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
298 <param name="assembly" value="false" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
299 <param name="min_2mer_repeats" value="8" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
300 <param name="input_fastq_r1" value="illuminaPE_r1_bad_ranges.fq" ftype="fastqsanger" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
301 <param name="input_fastq_r2" value="illuminaPE_r2_bad_ranges.fq" ftype="fastqsanger" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
302 <param name="min_2mer_repeats" value="8" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
303 <param name="min_3mer_repeats" value="8" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
304 <param name="min_4mer_repeats" value="8" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
305 <param name="min_5mer_repeats" value="8" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
306 <param name="min_6mer_repeats" value="8" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
307 <param name="primer_options" value="custom" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
308 <param name="primer_opt_size" value="25" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
309 <param name="primer_min_size" value="21" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
310 <param name="primer_max_size" value="30" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
311 <param name="primer_min_gc" value="40.0" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
312 <param name="primer_max_gc" value="60.0" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
313 <param name="primer_gc_clamp" value="3" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
314 <param name="primer_max_end_gc" value="5" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
315 <param name="primer_min_tm" value="60.0" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
316 <param name="primer_max_tm" value="80.0" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
317 <param name="primer_opt_tm" value="68.0" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
318 <param name="primer_pair_max_diff_tm" value="3.0" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
319 <param name="report_bad_primer_ranges" value="true" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
320 <expand macro="output_illumina_microsat_summary_bad_ranges" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
321 <output name="output_pal_summary" compare="re_match" file="illuminaPE_microsats_bad_ranges.out.re_match" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
322 <output name="output_bad_primer_read_ids" file="illuminaPE_bad_primer_read_ids.out" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
323 </test>
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
324 <!-- Test with bad n-mers specified -->
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
325 <test expect_failure="true">
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
326 <param name="platform_type" value="illumina" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
327 <param name="filters" value="" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
328 <param name="assembly" value="false" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
329 <param name="min_2mer_repeats" value="8" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
330 <param name="min_3mer_repeats" value="8" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
331 <param name="min_4mer_repeats" value="0" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
332 <param name="min_5mer_repeats" value="8" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
333 <param name="min_6mer_repeats" value="8" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
334 <param name="input_fastq_r1" value="illuminaPE_r1_no_microsats.fq" ftype="fastqsanger" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
335 <param name="input_fastq_r2" value="illuminaPE_r2_no_microsats.fq" ftype="fastqsanger" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
336 <assert_stderr>
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
337 <has_text text="Minimum number of 4-mers cannot be zero if number of 5-mers is non-zero" />
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
338 </assert_stderr>
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
339 </test>
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
340 <!-- Test with 454 input -->
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
341 <test>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
342 <param name="platform_type" value="454" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
343 <param name="input_fasta" value="454_in.fa" ftype="fasta" />
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
344 <expand macro="output_454_microsat_summary" />
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
345 <output name="output_pal_summary" compare="re_match" file="454_microsats.out.re_match" />
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
346 </test>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
347 </tests>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
348 <help>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
349 .. class:: infomark
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
350
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
351 **What it does**
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
352
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
353 This tool runs the pal_finder program, which finds microsatellite repeat elements
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
354 directly from raw 454 or Illumina paired-end sequencing reads. It then designs PCR
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
355 primers to amplify these repeat loci (Potentially Amplifiable Loci: PAL).
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
356
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
357 Optionally for Illumina data, one or more filters can be applied to the output from
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
358 pal_finder to:
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
359
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
360 * Only include loci with designed primers
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
361 * Exclude loci where the primer sequences occur more than once in the reads
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
362 * Only include loci with 'perfect' motifs (and rank by motif size,largest to
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
363 smallest)
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
364 * Use PANDAseq to assemble paired-end reads and confirm primer sequences are
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
365 present in high-quality assembly
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
366
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
367 Pal_finder runs the primer3_core program; information on the settings used in
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
368 primer3_core can be found in the Primer3 manual at
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
369 http://primer3.sourceforge.net/primer3_manual.htm
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
370
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
371 -------------
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
372
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
373 .. class:: infomark
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
374
8
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
375 **Known issues**
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
376
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
377 .. class:: warning
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
378
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
379 **Low number of reads used for microsatellite detection/bad primer product size ranges**
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
380
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
381 For some datasets pal_finder may generate 'bad' product size ranges (where the
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
382 lower limit exceeds the upper limit) for one or more reads, for input into
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
383 primer3_core. In these cases primer3_core will terminate prematurely, which can
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
384 result in a substantially lower number of reads being used for microsatellite
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
385 detection and potentially sub-optimal primer design.
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
386
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
387 The number of reads generating the bad size ranges are reported in the
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
388 *Summary of microsat types* output dataset as 'readsWithBadRanges'. Ideally
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
389 the reported value should be zero.
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
390
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
391 The conditions which cause this issue within pal_finder are still unclear,
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
392 however we believe it to be associated with short or low quality reads. If this
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
393 problem affects your data then:
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
394
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
395 * Ensure that the input data are sufficiently trimmed and filtered (using
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
396 e.g. the Trimmomatic tool) before rerunning pal_finder.
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
397
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
398 * A list of read IDs for which pal_finder generates bad product size ranges can
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
399 be output by turning on *Output IDs for input reads which generate bad primer
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
400 ranges*. This outputs an additional dataset with a list of read IDs which can
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
401 be used to remove read pairs from the input Fastq files (using e.g. the *Filter
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
402 sequences by ID* tool) before rerunning pal_finder.
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
403
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
404 .. class:: warning
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
405
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
406 **Pal_finder takes a long time to run for large input datasets**
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
407
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
408 pal_finder was originally developed using MiSeq data, and is not optimised for
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
409 working with the larger Fastqs that are output from other platforms such as
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
410 HiSeq and NextSeq. As a consequence pal_finder may take a very long time to
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
411 complete when operating on larger datasets.
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
412
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
413 If this is a problem then the tool can be run using a subset of the input reads
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
414 by unchecking the *Use all reads...* option and entering either an integer number
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
415 of reads to use, or a decimal fraction (e.g. 0.5 will select 50% of the reads).
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
416
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
417 -------------
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
418
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
419 .. class:: infomark
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
420
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
421 **Credits**
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
422
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
423 This Galaxy tool has been developed by Peter Briggs within the Bioinformatics Core
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
424 Facility at the University of Manchester. It runs the pal_finder package which can be
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
425 obtained from http://sourceforge.net/projects/palfinder/:
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
426
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
427 * PLoS One. 2012; 7(2): e30953 "Rapid Microsatellite Identification from Illumina Paired-End
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
428 Genomic Sequencing in Two Birds and a Snake" Todd A. Castoe, Alexander W. Poole, A. P.
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
429 Jason de Koning, Kenneth L. Jones, Diana F. Tomback, Sara J. Oyler-McCance, Jennifer A.
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
430 Fike, Stacey L. Lance, Jeffrey W. Streicher, Eric N. Smith, and David D. Pollock
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
431
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
432 The paper is available at http://www.ncbi.nlm.nih.gov/pmc/articles/PMC3279355/
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
433
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
434 This tool is compatible with pal_finder version 0.02.04, which in turn runs the
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
435 primer3_core program (version 2.0.0-alpha is required, available from
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
436 http://primer3.sourceforge.net/releases.php):
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
437
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
438 * Steve Rozen and Helen J. Skaletsky (2000) "Primer3 on the WWW for general users and for
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
439 biologist programmers". In: Krawetz S, Misener S (eds) Bioinformatics Methods and
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
440 Protocols: Methods in Molecular Biology. Humana Press, Totowa, NJ, pp 365-386
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
441
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
442 The paper is available at
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
443 http://purl.com/STEVEROZEN/papers/rozen-and-skaletsky-2000-primer3.pdf
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
444
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
445 The filtering and assembly of the pal_finder output for Illumina data is performed
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
446 using a Python utility written by Graeme Fox at the University of Manchester, and which
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
447 is included with this tool; this utility uses the BioPython and PANDAseq packages.
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
448
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
449 Please kindly acknowledge both this Galaxy tool, the pal_finder and primer3 packages, and
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
450 the utility script and its dependencies if you use it in your work.
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
451 </help>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
452 <citations>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
453 <!--
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
454 See https://wiki.galaxyproject.org/Admin/Tools/ToolConfigSyntax#A.3Ccitations.3E_tag_set
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
455 Can be either DOI or Bibtex
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
456 Use http://www.bioinformatics.org/texmed/ to convert PubMed to Bibtex
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
457 -->
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
458 <citation type="doi">10.1371/journal.pone.0030953</citation>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
459 <citation type="bibtex">@Article{pmid10547847,
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
460 Author="Rozen, S. and Skaletsky, H. ",
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
461 Title="{{P}rimer3 on the {W}{W}{W} for general users and for biologist programmers}",
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
462 Journal="Methods Mol. Biol.",
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
463 Year="2000",
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
464 Volume="132",
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
465 Pages="365--386",
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
466 URL="{http://purl.com/STEVEROZEN/papers/rozen-and-skaletsky-2000-primer3.pdf}"
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
467 }</citation>
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
468 <citation type="doi">10.1093/bioinformatics/btp163</citation>
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
469 <citation type="doi">10.1186/1471-2105-13-31</citation>
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
470 </citations>
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
471 </tool>