annotate final/create_annotation_sqlite.xml @ 4:9482a43a3d83 draft

Uploaded
author triasteran
date Tue, 01 Mar 2022 12:40:17 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
1 <tool id="create_annotation_sqlite" name="create annotation in sqlite for trips-viz" version="0.1.4">
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
2 <requirements>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
3 <container type="docker">triasteran/trips_create_annotation:latest</container>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
4 </requirements>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
5 <command detect_errors="exit_code"><![CDATA[
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
6 create_annotation_sqlite $annotation $fasta $pseudo_utr_len $transcript $gene $output
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
7 ]]></command>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
8 <inputs>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
9 <param format="gtf,gff" name="annotation" type="data" label="GTF/GFF3 File"/>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
10 <param format="fasta" name="fasta" type="data" label="Transcriptome FASTA file"/>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
11 <param name="pseudo_utr_len" type="text" label="Pseudo UTR length"/>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
12 <param name="transcript" type="text" label="Example transcript"/>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
13 <param name="gene" type="text" label="Example gene"/>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
14 </inputs>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
15 <outputs>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
16 <data format="sqlite" name="output" />
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
17 </outputs>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
18 <tests>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
19 <test>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
20 <param name="fasta" value="sacCer3_transcripts.fasta"/>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
21 <param name="annotation" value="saccharomyces_cerevisiae.R64-1-1.84.gtf"/>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
22 <param name="pseudo_utr_len" value="300"/>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
23 <param name="transcript" value="YDL248W"/>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
24 <param name="gene" value="COS7"/>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
25 <output name="output" file="output"/>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
26 </test>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
27 </tests>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
28 <help><![CDATA[
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
29 **GTF/GFF3 File**
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
30
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
31 GFF lines have nine required fields that must be tab-separated.
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
32 The GFF3 format addresses the most common extensions to GFF, while preserving backward compatibility with previous formats.
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
33
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
34 Both transcript ids and gene names should be listed in the file.
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
35
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
36 -----
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
37
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
38 **Transcriptome FASTA file**
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
39
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
40 A FASTA file with an entry for every transcript. The headers should be the transcript id's as they appear in the GTF/GFF3 file.
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
41
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
42 -----
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
43
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
44 **Psuedo UTR length**
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
45 An integer representing the length (in nucleotides) to be added to the 5' end and 3' end of every transcript with an annotated
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
46 CDS. Useful for when an organism does not have any annotated UTR's, if it does use 0. If not 0, the extra nucleotides should
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
47 already be present in the FASTA file.
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
48
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
49 -----
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
50
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
51 **Example transcript**
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
52
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
53 An example of a transcript id that appears in the FASTA/GTF/GFF3 file, e.g ENST00000123456
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
54
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
55 -----
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
56
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
57 **Example Gene**
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
58
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
59 An example of a gene name as it appears in the GTF/GFF3 file, e.g BRCA1
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
60
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
61 -----
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
62
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
63 **Output**
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
64
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
65 The output of the script can be downloaded and uploaded to Trips-viz_. by signing in and going to the uploads page, then selecting
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
66 "Upload new transcriptome". When uploaded the new organism will appear on the home page of Trips-viz, or under the transcriptomes
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
67 page if the organism name used is already present on Trips-viz.
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
68
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
69
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
70
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
71 .. _Trips-viz: http://trips.ucc.ie
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
72
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
73 ]]></help>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
74 <citations>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
75 <citation type="bibtex">
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
76 @misc{githubTrips-Viz,
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
77 author = {LastTODO, FirstTODO},
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
78 year = {TODO},
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
79 title = {Trips-Viz},
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
80 publisher = {GitHub},
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
81 journal = {GitHub repository},
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
82 url = {https://github.com/skiniry/Trips-Viz},
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
83 }</citation>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
84 </citations>
9482a43a3d83 Uploaded
triasteran
parents:
diff changeset
85 </tool>