Mercurial > repos > peterjc > get_orfs_or_cdss
annotate tools/get_orfs_or_cdss/get_orfs_or_cdss.xml @ 7:705a2e2df7fb draft
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
author | peterjc |
---|---|
date | Thu, 30 Jul 2015 12:35:31 -0400 |
parents | 5208c15805ec |
children | 09a8be9247ca |
rev | line source |
---|---|
7
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
1 <tool id="get_orfs_or_cdss" name="Get open reading frames (ORFs) or coding sequences (CDSs)" version="0.1.1"> |
5 | 2 <description>e.g. to get peptides from ESTs</description> |
3 <requirements> | |
7
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
4 <requirement type="package" version="1.65">biopython</requirement> |
5 | 5 <requirement type="python-module">Bio</requirement> |
6 </requirements> | |
7 <stdio> | |
8 <!-- Anything other than zero is an error --> | |
9 <exit_code range="1:" /> | |
10 <exit_code range=":-1" /> | |
11 </stdio> | |
7
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
12 <version_command interpreter="python">get_orfs_or_cdss.py --version</version_command> |
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
13 <command interpreter="python"> |
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
14 get_orfs_or_cdss.py -i $input_file -f $input_file.ext --table $table -t $ftype -e $ends -m $mode --min_len $min_len -s $strand --on $out_nuc_file --op $out_prot_file --ob $out_bed_file |
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
15 </command> |
5 | 16 <inputs> |
17 <param name="input_file" type="data" format="fasta,fastq,sff" label="Sequence file (nucleotides)" help="FASTA, FASTQ, or SFF format." /> | |
18 <param name="table" type="select" label="Genetic code" help="Tables from the NCBI, these determine the start and stop codons"> | |
19 <option value="1">1. Standard</option> | |
20 <option value="2">2. Vertebrate Mitochondrial</option> | |
21 <option value="3">3. Yeast Mitochondrial</option> | |
22 <option value="4">4. Mold, Protozoan, Coelenterate Mitochondrial and Mycoplasma/Spiroplasma</option> | |
23 <option value="5">5. Invertebrate Mitochondrial</option> | |
24 <option value="6">6. Ciliate Macronuclear and Dasycladacean</option> | |
25 <option value="9">9. Echinoderm Mitochondrial</option> | |
26 <option value="10">10. Euplotid Nuclear</option> | |
27 <option value="11">11. Bacterial</option> | |
28 <option value="12">12. Alternative Yeast Nuclear</option> | |
29 <option value="13">13. Ascidian Mitochondrial</option> | |
30 <option value="14">14. Flatworm Mitochondrial</option> | |
31 <option value="15">15. Blepharisma Macronuclear</option> | |
32 <option value="16">16. Chlorophycean Mitochondrial</option> | |
33 <option value="21">21. Trematode Mitochondrial</option> | |
34 <option value="22">22. Scenedesmus obliquus</option> | |
35 <option value="23">23. Thraustochytrium Mitochondrial</option> | |
7
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
36 <option value="24">24. Pterobranchia Mitochondrial</option> |
5 | 37 </param> |
38 <param name="ftype" type="select" value="True" label="Look for ORFs or CDSs"> | |
39 <option value="ORF">Look for ORFs (check for stop codons only, ignore start codons)</option> | |
40 <option value="CDS">Look for CDSs (with start and stop codons)</option> | |
41 </param> | |
42 <param name="ends" type="select" value="open" label="Sequence end treatment"> | |
43 <option value="open">Open ended (will allow missing start/stop codons at the ends)</option> | |
44 <option value="closed">Complete (will check for start/stop codons at the ends)</option> | |
45 <!-- TODO? Circular, for using this on finished bacteria etc --> | |
46 </param> | |
47 <param name="mode" type="select" label="Selection criteria" help="Suppose a sequence has ORFs/CDSs of lengths 100, 102 and 102 -- which should be taken? These options would return 3, 2 or 1 ORF."> | |
48 <option value="all">All ORFs/CDSs from each sequence</option> | |
49 <option value="top">All ORFs/CDSs from each sequence with the maximum length</option> | |
50 <option value="one">First ORF/CDS from each sequence with the maximum length</option> | |
51 </param> | |
52 <param name="min_len" type="integer" size="5" value="30" label="Minimum length ORF/CDS (in amino acids, e.g. 30 aa = 90 bp plus any stop codon)" /> | |
7
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
53 <param name="strand" type="select" label="Strand to search" help="Use the forward only option if your sequence directionality is known (e.g. from poly-A tails, or strand specific RNA sequencing)."> |
5 | 54 <option value="both">Search both the forward and reverse strand</option> |
55 <option value="forward">Only search the forward strand</option> | |
56 <option value="reverse">Only search the reverse strand</option> | |
57 </param> | |
58 </inputs> | |
59 <outputs> | |
60 <data name="out_nuc_file" format="fasta" label="${ftype.value}s (nucleotides)" /> | |
61 <data name="out_prot_file" format="fasta" label="${ftype.value}s (amino acids)" /> | |
7
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
62 <data name="out_bed_file" format="bed6" label="${ftype.value}s (bed)" /> |
5 | 63 </outputs> |
64 <tests> | |
65 <test> | |
66 <param name="input_file" value="get_orf_input.fasta" /> | |
67 <param name="table" value="1" /> | |
68 <param name="ftype" value="CDS" /> | |
69 <param name="ends" value="open" /> | |
70 <param name="mode" value="all" /> | |
71 <param name="min_len" value="10" /> | |
72 <param name="strand" value="forward" /> | |
73 <output name="out_nuc_file" file="get_orf_input.t1_nuc_out.fasta" /> | |
74 <output name="out_prot_file" file="get_orf_input.t1_prot_out.fasta" /> | |
7
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
75 <output name="out_bed_file" file="get_orf_input.t1_bed_out.bed" /> |
5 | 76 </test> |
77 <test> | |
78 <param name="input_file" value="get_orf_input.fasta" /> | |
79 <param name="table" value="11" /> | |
80 <param name="ftype" value="CDS" /> | |
81 <param name="ends" value="closed" /> | |
82 <param name="mode" value="all" /> | |
83 <param name="min_len" value="10" /> | |
84 <param name="strand" value="forward" /> | |
85 <output name="out_nuc_file" file="get_orf_input.t11_nuc_out.fasta" /> | |
7
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
86 <output name="out_prot_file" file="get_orf_input.t11_prot_out.fasta" /> |
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
87 <output name="out_bed_file" file="get_orf_input.t11_bed_out.bed" /> |
5 | 88 </test> |
89 <test> | |
90 <param name="input_file" value="get_orf_input.fasta" /> | |
91 <param name="table" value="11" /> | |
92 <param name="ftype" value="CDS" /> | |
93 <param name="ends" value="open" /> | |
94 <param name="mode" value="all" /> | |
95 <param name="min_len" value="10" /> | |
96 <param name="strand" value="forward" /> | |
97 <output name="out_nuc_file" file="get_orf_input.t11_open_nuc_out.fasta" /> | |
98 <output name="out_prot_file" file="get_orf_input.t11_open_prot_out.fasta" /> | |
7
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
99 <output name="out_bed_file" file="get_orf_input.t11_open_bed_out.bed" /> |
5 | 100 </test> |
101 <test> | |
102 <param name="input_file" value="Ssuis.fasta" /> | |
103 <param name="table" value="11" /> | |
104 <param name="ftype" value="ORF" /> | |
105 <param name="ends" value="open" /> | |
106 <param name="mode" value="all" /> | |
107 <param name="min_len" value="100" /> | |
108 <param name="strand" value="both" /> | |
109 <output name="out_nuc_file" file="get_orf_input.Suis_ORF.nuc.fasta" /> | |
110 <output name="out_prot_file" file="get_orf_input.Suis_ORF.prot.fasta" /> | |
7
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
111 <output name="out_bed_file" file="get_orf_input.Suis_ORF.bed" /> |
5 | 112 </test> |
113 </tests> | |
114 <help> | |
115 **What it does** | |
116 | |
117 Takes an input file of nucleotide sequences (typically FASTA, but also FASTQ | |
118 and Standard Flowgram Format (SFF) are supported), and searches each sequence | |
119 for open reading frames (ORFs) or potential coding sequences (CDSs) of the | |
120 given minimum length. These are returned as FASTA files of nucleotides and | |
121 protein sequences. | |
122 | |
123 You can choose to have all the ORFs/CDSs above the minimum length for each | |
124 sequence (similar to the EMBOSS getorf tool), those with the longest length | |
125 equal, or the first ORF/CDS with the longest length (in the special case | |
126 where a sequence encodes two or more long ORFs/CDSs of the same length). The | |
127 last option is a reasonable choice when the input sequences represent EST or | |
128 mRNA sequences, where only one ORF/CDS is expected. | |
129 | |
130 Note that if no ORFs/CDSs in a sequence match the criteria, there will be no | |
131 output for that sequence. | |
132 | |
133 Also note that the ORFs/CDSs are assigned modified identifiers to distinguish | |
134 them from the original full length sequences, by appending a suffix. | |
135 | |
136 The start and stop codons are taken from the `NCBI Genetic Codes | |
137 <http://www.ncbi.nlm.nih.gov/Taxonomy/Utils/wprintgc.cgi>`_. | |
138 When searching for ORFs, the sequences will run from stop codon to stop | |
139 codon, and any start codons are ignored. When searching for CDSs, the first | |
140 potential start codon will be used, giving the longest possible CDS within | |
141 each ORF, and thus the longest possible protein sequence. This is useful | |
142 for things like BLAST or domain searching, but since this may not be the | |
7
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
143 correct start codon, it may not be appropriate for signal peptide detection |
5 | 144 etc. |
145 | |
146 **Example Usage** | |
147 | |
148 Given some EST sequences (Sanger capillary reads) assembled into unigenes, | |
149 or a transcriptome assembly from some RNA-Seq, each of your nucleotide | |
150 sequences should (barring sequencing, assembly errors, frame-shifts etc) | |
151 encode one protein as a single ORF/CDS, which you wish to extract (and | |
152 perhaps translate into amino acids). | |
153 | |
7
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
154 If your RNA-Seq data was strand specific, and assembled taking this into |
5 | 155 account, you should only search for ORFs/CDSs on the forward strand. |
156 | |
157 **Citation** | |
158 | |
159 If you use this Galaxy tool in work leading to a scientific publication please | |
160 cite the following paper: | |
161 | |
162 Peter J.A. Cock, Björn A. Grüning, Konrad Paszkiewicz and Leighton Pritchard (2013). | |
163 Galaxy tools and workflows for sequence analysis with applications | |
164 in molecular plant pathology. PeerJ 1:e167 | |
165 http://dx.doi.org/10.7717/peerj.167 | |
166 | |
167 This tool uses Biopython, so you may also wish to cite the Biopython | |
168 application note (and Galaxy too of course): | |
169 | |
170 Cock et al (2009). Biopython: freely available Python tools for computational | |
171 molecular biology and bioinformatics. Bioinformatics 25(11) 1422-3. | |
172 http://dx.doi.org/10.1093/bioinformatics/btp163 pmid:19304878. | |
173 | |
174 This tool is available to install into other Galaxy Instances via the Galaxy | |
175 Tool Shed at http://toolshed.g2.bx.psu.edu/view/peterjc/get_orfs_or_cdss | |
176 </help> | |
7
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
177 <citations> |
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
178 <citation type="doi">10.7717/peerj.167</citation> |
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
179 <citation type="doi">10.1093/bioinformatics/btp163</citation> |
705a2e2df7fb
v0.1.1 fix typo; v0.1.0 BED output (Eric Rasche), NCBI genetic code 24; v0.0.7 embeds citation
peterjc
parents:
5
diff
changeset
|
180 </citations> |
5 | 181 </tool> |