annotate cpt_promote_qualifiers/promote_qualifier.xml @ 0:6f4c46313117 draft default tip

Uploaded
author cpt
date Fri, 17 Jun 2022 13:05:11 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6f4c46313117 Uploaded
cpt
parents:
diff changeset
1 <?xml version="1.0"?>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
2 <tool id="edu.tamu.cpt.gff3.promote_qualifiers" name="Promote Qualifers" version="20.0.0">
6f4c46313117 Uploaded
cpt
parents:
diff changeset
3 <description>Promote a child feature's qualifier into the parent feature</description>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
4 <macros>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
5 <import>macros.xml</import>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
6 <import>cpt-macros.xml</import>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
7 </macros>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
8 <expand macro="requirements"/>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
9 <command detect_errors="aggressive"><![CDATA[
6f4c46313117 Uploaded
cpt
parents:
diff changeset
10 python $__tool_directory__/promote_qualifier.py
6f4c46313117 Uploaded
cpt
parents:
diff changeset
11 @INPUT_GFF@
6f4c46313117 Uploaded
cpt
parents:
diff changeset
12 $parent
6f4c46313117 Uploaded
cpt
parents:
diff changeset
13 $child
6f4c46313117 Uploaded
cpt
parents:
diff changeset
14 $qualifier
6f4c46313117 Uploaded
cpt
parents:
diff changeset
15 > $output]]></command>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
16 <inputs>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
17 <expand macro="gff3_input" />
6f4c46313117 Uploaded
cpt
parents:
diff changeset
18 <param label="Parent Feature Type" name="parent" type="text" help="e.g. gene, mRNA, exon" />
6f4c46313117 Uploaded
cpt
parents:
diff changeset
19 <param label="Child Feature Type" name="child" type="text" help="e.g. mRNA, exon, CDS" />
6f4c46313117 Uploaded
cpt
parents:
diff changeset
20 <param label="Qualifer to Promote" name="qualifier" type="text" help="e.g. Name, Product, Notes" />
6f4c46313117 Uploaded
cpt
parents:
diff changeset
21 </inputs>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
22 <outputs>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
23 <data format="gff3" name="output" />
6f4c46313117 Uploaded
cpt
parents:
diff changeset
24 </outputs>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
25 <tests>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
26 <test>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
27 <param name="gff3_data" value="promote_qualifiers_in.gff3" />
6f4c46313117 Uploaded
cpt
parents:
diff changeset
28 <param name="parent" value="gene" />
6f4c46313117 Uploaded
cpt
parents:
diff changeset
29 <param name="child" value="mRNA" />
6f4c46313117 Uploaded
cpt
parents:
diff changeset
30 <param name="qualifier" value="Name" />
6f4c46313117 Uploaded
cpt
parents:
diff changeset
31 <output name="output" file="promote_qualifiers_out.gff3" />
6f4c46313117 Uploaded
cpt
parents:
diff changeset
32 </test>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
33 </tests>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
34 <help><![CDATA[
6f4c46313117 Uploaded
cpt
parents:
diff changeset
35 **What it does**
6f4c46313117 Uploaded
cpt
parents:
diff changeset
36
6f4c46313117 Uploaded
cpt
parents:
diff changeset
37 Allows you to copy a specified qualifier value from a child feature into a parent feature, most likely to copy the Name from an mRNA into a gene.
6f4c46313117 Uploaded
cpt
parents:
diff changeset
38
6f4c46313117 Uploaded
cpt
parents:
diff changeset
39 For example, for a *Parent Feature Type* of "gene", *Child Feature Type* of "mRNA", and *Qualifier to Promote* of "Name" the following gff will be changed (spacing for emphasis):
6f4c46313117 Uploaded
cpt
parents:
diff changeset
40
6f4c46313117 Uploaded
cpt
parents:
diff changeset
41 *Before*::
6f4c46313117 Uploaded
cpt
parents:
diff changeset
42
6f4c46313117 Uploaded
cpt
parents:
diff changeset
43 NC_049846.1 . gene 630 1182 . + . ID=8942304a;date_last_modified=2020-09-25; Name=NC_049846.1.gene_1 ;date_creation=2020-09-25
6f4c46313117 Uploaded
cpt
parents:
diff changeset
44 NC_049846.1 . mRNA 630 1182 . + . Parent=8942304a;ID=536ddf54; Name=Gene_1_Name ;date_creation=2020-09-25
6f4c46313117 Uploaded
cpt
parents:
diff changeset
45
6f4c46313117 Uploaded
cpt
parents:
diff changeset
46 *After*::
6f4c46313117 Uploaded
cpt
parents:
diff changeset
47
6f4c46313117 Uploaded
cpt
parents:
diff changeset
48 NC_049846.1 . gene 630 1182 . + . ID=8942304a;date_last_modified=2020-09-25; Name=Gene_1_Name ;date_creation=2020-09-25
6f4c46313117 Uploaded
cpt
parents:
diff changeset
49 NC_049846.1 . mRNA 630 1182 . + . Parent=8942304a;ID=536ddf54; Name=Gene_1_Name ;date_creation=2020-09-25
6f4c46313117 Uploaded
cpt
parents:
diff changeset
50
6f4c46313117 Uploaded
cpt
parents:
diff changeset
51 .. class:: infomark
6f4c46313117 Uploaded
cpt
parents:
diff changeset
52
6f4c46313117 Uploaded
cpt
parents:
diff changeset
53 **Notes**::
6f4c46313117 Uploaded
cpt
parents:
diff changeset
54
6f4c46313117 Uploaded
cpt
parents:
diff changeset
55 - If the qualifier is already present in the parent, it will be overwritten with the child's value.
6f4c46313117 Uploaded
cpt
parents:
diff changeset
56 - If there are multiple child features of the specified type under the same parent, the value from the first child. This action is strand aware.
6f4c46313117 Uploaded
cpt
parents:
diff changeset
57 - For positive strand features it will select the child with the smaller start coordinate.
6f4c46313117 Uploaded
cpt
parents:
diff changeset
58 - For negative strand it will select the child with the largest end coordinate.
6f4c46313117 Uploaded
cpt
parents:
diff changeset
59
6f4c46313117 Uploaded
cpt
parents:
diff changeset
60 .. class:: warningmark
6f4c46313117 Uploaded
cpt
parents:
diff changeset
61
6f4c46313117 Uploaded
cpt
parents:
diff changeset
62 **Warning**::
6f4c46313117 Uploaded
cpt
parents:
diff changeset
63
6f4c46313117 Uploaded
cpt
parents:
diff changeset
64 You should likely never run this to promote the "ID" qualifier as this will break the gff3 hierarchy structure and cause parsing failures downstream.
6f4c46313117 Uploaded
cpt
parents:
diff changeset
65 ]]></help>
6f4c46313117 Uploaded
cpt
parents:
diff changeset
66 <expand macro="citations-clm" />
6f4c46313117 Uploaded
cpt
parents:
diff changeset
67 </tool>