genomer-plugin-view 0.0.6 → 0.0.7
Sign up to get free protection for your applications and to get access to all the features.
- data/lib/genomer-plugin-view/version.rb +1 -1
- data/man/genomer-view.ronn +13 -13
- metadata +2 -2
data/man/genomer-view.ronn
CHANGED
@@ -60,7 +60,7 @@ begin with an upper case letter.
|
|
60
60
|
* `Name`:
|
61
61
|
Used to specify the four letter annotation name, e.g. pilO. The lower case
|
62
62
|
version is used for gene names. If the `--generate_encoded_features` option
|
63
|
-
is passed,
|
63
|
+
is passed, additional encoded feature entries have the `product` field
|
64
64
|
generated from this capitalised version of this attribute. This need not be
|
65
65
|
unique in the file.
|
66
66
|
|
@@ -69,26 +69,26 @@ begin with an upper case letter.
|
|
69
69
|
`--generate_encoded_features` option is passed.
|
70
70
|
|
71
71
|
* `DBxref`: Used to link the annotation to other database references. This
|
72
|
-
field is added verbatim to generated output. Multiple
|
72
|
+
field is added verbatim to generated output. Multiple entries of this
|
73
73
|
field may be used.
|
74
74
|
|
75
75
|
### GENOMER ATTRIBUTES
|
76
76
|
|
77
77
|
These attributes are specific to genomer and should begin with a lower case
|
78
78
|
letter. Many of these attributes have a corresponding relationship with fields
|
79
|
-
in
|
79
|
+
in GenBank table format, however a caveat to this is outlined in the next
|
80
80
|
section.
|
81
81
|
|
82
82
|
* `product`:
|
83
83
|
Used to populate the **product** field for encoded features when the
|
84
84
|
`--generate_encoded_features` option is passed. If the **Name** attribute
|
85
|
-
is also present then the **
|
85
|
+
is also present then the **function** field is instead populated with this
|
86
86
|
value.
|
87
87
|
|
88
|
-
* `
|
88
|
+
* `feature_type`:
|
89
89
|
When the gene product is not a CDS this field can be used, when the
|
90
90
|
`--generate_encoded_features` option is passed, as the corresponding entry
|
91
|
-
type instead of `CDS`. The
|
91
|
+
type instead of `CDS`. The GenBank specification list examples for `rRNA`,
|
92
92
|
`tmRNA`, `tRNA`, and `miscRNA`. If you require other feature type
|
93
93
|
implemented, please contact me through the website below.
|
94
94
|
|
@@ -105,31 +105,31 @@ section.
|
|
105
105
|
|
106
106
|
### OVERLAP BETWEEN NAME, PRODUCT AND FUNCTION FIELD
|
107
107
|
|
108
|
-
The
|
108
|
+
The GenBank annotation table **product** fields may contain either a short four
|
109
109
|
letter name (e.g. pilO) or a longer gene description (e.g. pilus assembly
|
110
110
|
protein). This presents a problem where data may need to be juggled between the
|
111
111
|
**Name**, **product** and **function** fields depending on what is information
|
112
|
-
is
|
112
|
+
is available.
|
113
113
|
|
114
114
|
Genomer view solves this problem by prioritising these fields in the following
|
115
115
|
order: **Name** > **product** > **function**. If the **Name** attribute is
|
116
|
-
present this will be used for the **product** field in the resulting
|
116
|
+
present this will be used for the **product** field in the resulting GenBank
|
117
117
|
table. If the **product** attribute is also present at the same time this will
|
118
|
-
instead be used to fill out the **function** field in the
|
118
|
+
instead be used to fill out the **function** field in the GenBank table. If
|
119
119
|
only the **product** and **function** attributes are present then these then
|
120
|
-
map to corresponding fields in
|
120
|
+
map to corresponding fields in GenBank table.
|
121
121
|
|
122
122
|
### RECOMMENDED FORMAT FOR ANNOTATIONS
|
123
123
|
|
124
124
|
All entries should contain a unique `ID` attribute. A `Name` field be used
|
125
125
|
whenever an appropriate four letter name is also available, e.g. 'pilO'. The ID
|
126
|
-
field alone is
|
126
|
+
field alone is sufficient for generating a gene-only annotation table. Generally
|
127
127
|
however you will want to generate the encoded annotations also using the
|
128
128
|
`--generate_encoded_annotations` command line flag..
|
129
129
|
|
130
130
|
The majority of encoded annotations will be CDS entries but most genomes will
|
131
131
|
also contain RNA non-coding features. CDS annotations should contain either a
|
132
|
-
`product` and/or `Name` field to match the
|
132
|
+
`product` and/or `Name` field to match the GenBank requirements. In general it
|
133
133
|
may be easier to fill out all the `product` field for entries then add names
|
134
134
|
for entries where possible.
|
135
135
|
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: genomer-plugin-view
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.7
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -187,7 +187,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
187
187
|
version: '0'
|
188
188
|
segments:
|
189
189
|
- 0
|
190
|
-
hash:
|
190
|
+
hash: 2540489728296141443
|
191
191
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
192
192
|
none: false
|
193
193
|
requirements:
|