Mercurial > repos > peterjc > seq_primer_clip
annotate tools/seq_primer_clip/seq_primer_clip.xml @ 5:530c8d6fedd8 draft
v0.0.15 - internal changes
author | peterjc |
---|---|
date | Wed, 10 May 2017 13:09:52 -0400 |
parents | 9b074c1db68e |
children | b9dc7c967ee6 |
rev | line source |
---|---|
5 | 1 <tool id="seq_primer_clip" name="Primer clip sequences" version="0.0.15"> |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
2 <description>Trim off 5' or 3' primers</description> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
3 <requirements> |
4 | 4 <requirement type="package" version="1.0.1">galaxy_sequence_utils</requirement> |
5 <requirement type="package" version="1.67">biopython</requirement> | |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
6 </requirements> |
5 | 7 <version_command> |
8 python $__tool_directory__/seq_primer_clip.py --version | |
9 </version_command> | |
10 <command detect_errors="aggressive"> | |
11 python $__tool_directory__/seq_primer_clip.py $input_file $input_file.ext $primer_fasta $primer_type $mm $min_len $keep_negatives $output_file | |
4 | 12 </command> |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
13 <inputs> |
4 | 14 <param name="input_file" type="data" format="fasta,fastq,sff" label="Sequence file to clip" help="FASTA, FASTQ, or SFF format."/> |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
15 <param name="primer_fasta" type="data" format="fasta" label="FASTA file containing primer(s)"/> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
16 <param name="primer_type" type="select" label="Type of primers"> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
17 <option value="Forward">Forward (5') primers</option> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
18 <option value="Reverse">Reverse (3') primers (given with respect to the forward strand)</option> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
19 <option value="Reverse-complement">Reverse (3') primers (given with respect to the reverse strand)</option> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
20 </param> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
21 <param name="mm" type="integer" value="0" label="How many mismatches to allow? (0, 1 or 2)"> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
22 <validator type="in_range" min="0" max="2" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
23 </param> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
24 <param name="keep_negatives" type="boolean" value="false" label="Keep reads with no matched primer"/> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
25 <param name="min_len" type="integer" label="Minimum length for (clipped) sequences " value="1"/> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
26 </inputs> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
27 <outputs> |
4 | 28 <data name="output_file" format_source="input_file" metadata_source="input_file" label="$primer_type primer clipped"/> |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
29 </outputs> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
30 <tests> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
31 <test> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
32 <param name="input_file" value="MID4_GLZRM4E04_rnd30.fasta" ftype="fasta" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
33 <param name="primer_fasta" value="dop_primers.fasta" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
34 <param name="primer_type" value="Forward" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
35 <param name="mm" value="2" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
36 <param name="keep_negatives" value="false" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
37 <param name="min_len" value="35" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
38 <output name="output_file" file="MID4_GLZRM4E04_rnd30_fclip.fasta" ftype="fasta" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
39 </test> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
40 <test> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
41 <param name="input_file" value="MID4_GLZRM4E04_rnd30.fastqsanger" ftype="fastqsanger" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
42 <param name="primer_fasta" value="dop_primers.fasta" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
43 <param name="primer_type" value="Forward" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
44 <param name="mm" value="2" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
45 <param name="keep_negatives" value="false" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
46 <param name="min_len" value="35" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
47 <output name="output_file" file="MID4_GLZRM4E04_rnd30_fclip.fastqsanger" ftype="fastqsanger" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
48 </test> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
49 <test> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
50 <param name="input_file" value="MID4_GLZRM4E04_rnd30.sff" ftype="sff" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
51 <param name="primer_fasta" value="dop_primers.fasta" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
52 <param name="primer_type" value="Forward" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
53 <param name="mm" value="2" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
54 <param name="keep_negatives" value="false" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
55 <param name="min_len" value="35" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
56 <output name="output_file" file="MID4_GLZRM4E04_rnd30_fclip.sff" ftype="sff" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
57 </test> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
58 <test> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
59 <param name="input_file" value="MID4_GLZRM4E04_rnd30_fclip.fasta" ftype="fasta" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
60 <param name="primer_fasta" value="dop_primers.fasta" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
61 <param name="primer_type" value="Reverse" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
62 <param name="mm" value="2" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
63 <param name="keep_negatives" value="true" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
64 <param name="min_len" value="35" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
65 <output name="output_file" file="MID4_GLZRM4E04_rnd30_frclip.fasta" ftype="fasta" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
66 </test> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
67 <test> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
68 <param name="input_file" value="MID4_GLZRM4E04_rnd30_fclip.fastqsanger" ftype="fastqsanger" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
69 <param name="primer_fasta" value="dop_primers.fasta" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
70 <param name="primer_type" value="Reverse" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
71 <param name="mm" value="2" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
72 <param name="keep_negatives" value="true" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
73 <param name="min_len" value="35" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
74 <output name="output_file" file="MID4_GLZRM4E04_rnd30_frclip.fastqsanger" ftype="fastqsanger" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
75 </test> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
76 <test> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
77 <param name="input_file" value="MID4_GLZRM4E04_rnd30_fclip.sff" ftype="sff" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
78 <param name="primer_fasta" value="dop_primers.fasta" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
79 <param name="primer_type" value="Reverse" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
80 <param name="mm" value="2" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
81 <param name="keep_negatives" value="true" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
82 <param name="min_len" value="35" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
83 <output name="output_file" file="MID4_GLZRM4E04_rnd30_frclip.sff" ftype="sff" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
84 </test> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
85 </tests> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
86 <help> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
87 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
88 **What it does** |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
89 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
90 Looks for the given primer sequences (within the existing clipped sequence) and |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
91 further clips the reads to remove the primers and any preceding/trailing sequence. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
92 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
93 Reads containing a forward primer are reduced to just the sequence after (and |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
94 excluding) the forward primer. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
95 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
96 Reads containing a reverse primer are reduced to just the sequence before (and |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
97 excluding) the reverse primer. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
98 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
99 Degenerate primers can be specified using the standard IUPAC ambiguity codes, |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
100 thus a primer with an N would match A, C, T or G (or any of the IUPAC ambiguity |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
101 codes) and so on. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
102 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
103 Note that for SFF files only the clip/trim positions are edited - you will still |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
104 be able to extract the original full read (with any adapter sequence and poor |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
105 quality sequence) if you need to. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
106 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
107 .. class:: warningmark |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
108 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
109 **Note**. This tool was initially written for Roche 454 data, and should also |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
110 work fine on Sanger or Ion Torrent as well. However, it is probably too slow |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
111 for use on large Illumina datasets. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
112 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
113 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
114 **Citation** |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
115 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
116 This tool uses Biopython. If you use this tool in scientific work leading to a |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
117 publication, please cite: |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
118 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
119 Cock et al 2009. Biopython: freely available Python tools for computational |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
120 molecular biology and bioinformatics. Bioinformatics 25(11) 1422-3. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
121 http://dx.doi.org/10.1093/bioinformatics/btp163 pmid:19304878. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
122 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
123 This tool is available to install into other Galaxy Instances via the Galaxy |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
124 Tool Shed at http://toolshed.g2.bx.psu.edu/view/peterjc/seq_primer_clip |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
125 </help> |
4 | 126 <citations> |
127 <citation type="doi">10.1093/bioinformatics/btp163</citation> | |
128 </citations> | |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
129 </tool> |