annotate canongff3.xml @ 1:c45c9dd066e2 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
author iuc
date Sun, 11 Feb 2024 11:29:29 +0000
parents 3f438bf5475d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
1 <tool id="aegean_canongff3" name="AEGeAn CanonGFF3" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="20.01">
0
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
2 <description> pre-process GFF3 files, removing all features not directly related to protein-coding genes</description>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
3 <macros>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
4 <import>macros.xml</import>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
5 </macros>
1
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
6 <expand macro="edam_ontology"/>
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
7 <expand macro="xrefs"/>
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
8 <expand macro="requirements"/>
0
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
9 <version_command>canon-gff3 --version</version_command>
1
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
10 <command detect_errors="exit_code">
0
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
11 <![CDATA[
1
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
12 canon-gff3 "$gff3file"
0
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
13 $infer
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
14 #if $source
1
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
15 -s "$source"
0
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
16 #end if
1
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
17 -o "$output"
0
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
18 ]]>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
19 </command>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
20 <inputs>
1
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
21 <param name="gff3file" type="data" format="gff3" label="GFF3 File"
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
22 help="GFF3 annotation file" multiple="true" />
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
23 <param argument="--infer" type="boolean"
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
24 truevalue="--infer" falsevalue=""
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
25 label="Infer gene feature for transcripts lacking it"
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
26 help="For transcript features lacking an explicitly declared gene feature as a parent, create this feature on-they-fly"/>
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
27 <param argument="--source" type="text"
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
28 value="" optional="true"
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
29 label="Reset the source of each feature"
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
30 help="Reset the source of each feature to the given value. Source keywords can be a program (e.g. RepeatMasker) or an organization (like TAIR)">
0
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
31 <validator type="regex" message="Please only use letters, numbers or underscores in sample label">^[\w]+$</validator>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
32 </param>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
33 </inputs>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
34 <outputs>
1
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
35 <data name="output" format="gff3" />
0
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
36 </outputs>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
37 <tests>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
38 <test>
1
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
39 <param name="gff3file" value="TAIR10_GFF3_genes.gff" ftype="gff3"/>
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
40 <output name="output" file="canon-output_test1.gff3"/>
0
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
41 </test>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
42 <test>
1
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
43 <param name="gff3file" value="TAIR10_GFF3_genes.gff" ftype="gff3"/>
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
44 <param name="source" value="test_source"/>
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
45 <output name="output" file="canon-output_test2.gff3"/>
0
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
46 </test>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
47 <test>
1
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
48 <param name="gff3file" value="TAIR10_GFF3_genes.gff" ftype="gff3"/>
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
49 <param name="infer" value="true"/>
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
50 <output name="output" file="canon-output_test3.gff3"/>
0
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
51 </test>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
52 </tests>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
53 <help>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
54 <![CDATA[
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
55 .. class:: infomark
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
56
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
57 **Purpose**
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
58
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
59 CanonGFF3 is a program for pre-processing GFF3 data encoding canonical protein-coding genes. It will clean up a GFF3 file, removing all features not directly related to protein-coding genes and inferring features that are not explicitly declared, such as inrons and UTRs. Under the hood, CanonGFF3 essentially applies the same procedure used by ParsEval when it inspects its GFF3 input.
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
60
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
61 -----
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
62
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
63 .. class:: infomark
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
64
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
65 **Input**
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
66
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
67 Input for CanonGFF3 is one or more files in GFF3 forma. Aside from compliance to GFF3 syntax, CanonGFF3 requires only that protein coding genes be described in enough detail that the entire gene structure can be interpreted.
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
68
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
69 For example, one common convention is to use exon and CDS features to describe the structure. No intron, UTR, or start/stop features are explicitly provided, but these can be inferred from the other features. An alternative convention is to only declare exon and start & stop codon features, which requires the introns, UTRs, and CDS to be inferred. CanonGFF3 is pretty flexible in its handling of these various conventions, assuming the gene structure is described in sufficient detail.
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
70
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
71 -----
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
72
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
73 .. class:: infomark
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
74
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
75 **Output**
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
76
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
77 CanonGFF3 output is a GFF3 file containing protein-coding genes from the provided input file(s).
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
78
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
79 ]]>
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
80 </help>
1
c45c9dd066e2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit 669dd4d406e86aee7d83e7420dced981c180d805
iuc
parents: 0
diff changeset
81 <expand macro="citations"/>
0
3f438bf5475d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/aegean commit e6c01517075cab35e620fe1bbdb5fd68e4d1359f"
iuc
parents:
diff changeset
82 </tool>