annotate trips_create_new_organism/create_annotation_sqlite.xml @ 2:4af7eb738348 draft

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