annotate cpt_get_orfs/get_orfs_or_cdss.xml @ 1:77da06bc38f5 draft

Uploaded
author cpt
date Fri, 20 May 2022 07:21:00 +0000
parents daab1b0e68c1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
1 <tool id="get_orfs_or_cdss" name="Get open reading frames (ORFs) or coding sequences (CDSs)" version="19.1.0.0">
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
2 <description>e.g. to get peptides from ESTs</description>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
3 <macros>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
4 <import>macros.xml</import>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
5 <import>cpt-macros.xml</import>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
6 </macros>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
7 <expand macro="requirements">
1
77da06bc38f5 Uploaded
cpt
parents: 0
diff changeset
8 <requirement type="package" version="2022.1.18">regex</requirement>
0
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
9 </expand>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
10 <command interpreter="python" detect_errors="aggressive">
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
11 get_orfs_or_cdss.py $input_file -f $input_file.ext --table $table -t $ftype -e "closed" -m "all" --min_len $min_len --strand $strand --on $out_nuc_file --op $out_prot_file --ob $out_bed_file --og $out_gff3_file
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
12 </command>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
13 <inputs>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
14 <param name="input_file" type="data" format="fasta,fastq,sff" label="Sequence file (nucleotides)" help="FASTA, FASTQ, or SFF format." />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
15 <param name="table" type="select" label="Genetic code" help="Tables from the NCBI, these determine the start and stop codons">
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
16 <option value="1">1. Standard</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
17 <option value="2">2. Vertebrate Mitochondrial</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
18 <option value="3">3. Yeast Mitochondrial</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
19 <option value="4">4. Mold, Protozoan, Coelenterate Mitochondrial and Mycoplasma/Spiroplasma</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
20 <option value="5">5. Invertebrate Mitochondrial</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
21 <option value="6">6. Ciliate Macronuclear and Dasycladacean</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
22 <option value="9">9. Echinoderm Mitochondrial</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
23 <option value="10">10. Euplotid Nuclear</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
24 <option value="11">11. Bacterial</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
25 <option value="12">12. Alternative Yeast Nuclear</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
26 <option value="13">13. Ascidian Mitochondrial</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
27 <option value="14">14. Flatworm Mitochondrial</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
28 <option value="15">15. Blepharisma Macronuclear</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
29 <option value="16">16. Chlorophycean Mitochondrial</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
30 <option value="21">21. Trematode Mitochondrial</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
31 <option value="22">22. Scenedesmus obliquus</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
32 <option value="23">23. Thraustochytrium Mitochondrial</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
33 <option value="24">24. Pterobranchia Mitochondrial</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
34 </param>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
35 <param name="ftype" type="select" value="True" label="Look for ORFs or CDSs">
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
36 <option value="ORF">Look for ORFs (check for stop codons only, ignore start codons)</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
37 <option value="CDS">Look for CDSs (with start and stop codons)</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
38 </param>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
39 <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)" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
40 <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).">
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
41 <option value="both">Search both the forward and reverse strand</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
42 <option value="forward">Only search the forward strand</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
43 <option value="reverse">Only search the reverse strand</option>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
44 </param>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
45 </inputs>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
46 <outputs>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
47 <data name="out_nuc_file" format="fasta" label="${ftype.value}s (nucleotides)" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
48 <data name="out_prot_file" format="fasta" label="${ftype.value}s (amino acids)" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
49 <data name="out_bed_file" format="bed6" label="${ftype.value}s (bed)" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
50 <data name="out_gff3_file" format="gff3" label="${ftype.value}s (gff3)" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
51 </outputs>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
52 <tests>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
53 <test>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
54 <param name="input_file" value="Orf_T7In.fasta" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
55 <param name="table" value="11" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
56 <param name="ftype" value="ORF" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
57 <param name="min_len" value="30" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
58 <param name="strand" value="both" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
59 <output name="out_nuc_file" file="Orf_T7Out_Nuc.fasta" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
60 <output name="out_prot_file" file="Orf_T7Out_AA.fasta" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
61 <output name="out_bed_file" file="Orf_T7Out_Bed.bed" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
62 <output name="out_gff3_file" file="Orf_T7Out_Gff.gff3" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
63 </test>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
64 <test>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
65 <param name="input_file" value="Orf_In2.fasta" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
66 <param name="table" value="1" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
67 <param name="ftype" value="CDS" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
68 <param name="min_len" value="10" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
69 <param name="strand" value="forward" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
70 <output name="out_nuc_file" file="Orf_Out2T1_Nuc.fasta" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
71 <output name="out_prot_file" file="Orf_Out2T1_AA.fasta" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
72 <output name="out_bed_file" file="Orf_Out2T1_Bed.bed" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
73 <output name="out_gff3_file" file="Orf_Out2T1_Gff.gff3" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
74 </test>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
75 <test>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
76 <param name="input_file" value="Orf_In2.fasta" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
77 <param name="table" value="11" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
78 <param name="ftype" value="CDS" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
79 <param name="min_len" value="10" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
80 <param name="strand" value="forward" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
81 <output name="out_nuc_file" file="Orf_Out2T11_Nuc.fasta" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
82 <output name="out_prot_file" file="Orf_Out2T11_AA.fasta" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
83 <output name="out_bed_file" file="Orf_Out2T11_Bed.bed" />
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
84 <output name="out_gff3_file" file="Orf_Out2T11_Gff.gff3" /> </test>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
85 </tests>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
86 <help>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
87 **What it does**
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
88
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
89 Takes an input file of nucleotide sequences (typically FASTA, but also FASTQ
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
90 and Standard Flowgram Format (SFF) are supported), and searches each sequence
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
91 for open reading frames (ORFs) or potential coding sequences (CDSs) of the
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
92 given minimum length. These are returned as FASTA files of nucleotides and
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
93 protein sequences.
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
94
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
95 You can choose to have all the ORFs/CDSs above the minimum length for each
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
96 sequence (similar to the EMBOSS getorf tool), those with the longest length
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
97 equal, or the first ORF/CDS with the longest length (in the special case
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
98 where a sequence encodes two or more long ORFs/CDSs of the same length). The
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
99 last option is a reasonable choice when the input sequences represent EST or
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
100 mRNA sequences, where only one ORF/CDS is expected.
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
101
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
102 Note that if no ORFs/CDSs in a sequence match the criteria, there will be no
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
103 output for that sequence.
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
104
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
105 Also note that the ORFs/CDSs are assigned modified identifiers to distinguish
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
106 them from the original full length sequences, by appending a suffix.
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
107
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
108 The start and stop codons are taken from the `NCBI Genetic Codes
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
109 &lt;http://www.ncbi.nlm.nih.gov/Taxonomy/Utils/wprintgc.cgi&gt;`_.
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
110 When searching for ORFs, the sequences will run from stop codon to stop
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
111 codon, and any start codons are ignored. When searching for CDSs, the first
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
112 potential start codon will be used, giving the longest possible CDS within
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
113 each ORF, and thus the longest possible protein sequence. This is useful
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
114 for things like BLAST or domain searching, but since this may not be the
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
115 correct start codon, it may not be appropriate for signal peptide detection
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
116 etc.
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
117
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
118 **Example Usage**
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
119
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
120 Given some EST sequences (Sanger capillary reads) assembled into unigenes,
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
121 or a transcriptome assembly from some RNA-Seq, each of your nucleotide
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
122 sequences should (barring sequencing, assembly errors, frame-shifts etc)
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
123 encode one protein as a single ORF/CDS, which you wish to extract (and
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
124 perhaps translate into amino acids).
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
125
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
126 If your RNA-Seq data was strand specific, and assembled taking this into
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
127 account, you should only search for ORFs/CDSs on the forward strand.
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
128
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
129 **Citation**
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
130
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
131 If you use this Galaxy tool in work leading to a scientific publication please
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
132 cite the following paper:
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
133
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
134 Peter J.A. Cock, Björn A. Grüning, Konrad Paszkiewicz and Leighton Pritchard (2013).
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
135 Galaxy tools and workflows for sequence analysis with applications
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
136 in molecular plant pathology. PeerJ 1:e167
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
137 http://dx.doi.org/10.7717/peerj.167
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
138
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
139 This tool uses Biopython, so you may also wish to cite the Biopython
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
140 application note (and Galaxy too of course):
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
141
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
142 Cock et al (2009). Biopython: freely available Python tools for computational
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
143 molecular biology and bioinformatics. Bioinformatics 25(11) 1422-3.
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
144 http://dx.doi.org/10.1093/bioinformatics/btp163 pmid:19304878.
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
145
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
146 This tool is available to install into other Galaxy Instances via the Galaxy
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
147 Tool Shed at http://toolshed.g2.bx.psu.edu/view/peterjc/get_orfs_or_cdss
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
148 </help>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
149 <citations>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
150 <citation type="doi">10.7717/peerj.167</citation>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
151 <citation type="doi">10.1093/bioinformatics/btp163</citation>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
152 </citations>
daab1b0e68c1 Uploaded
cpt
parents:
diff changeset
153 </tool>