genomer-plugin-view 0.0.4 → 0.0.5

Sign up to get free protection for your applications and to get access to all the features.
data/README.md ADDED
@@ -0,0 +1,90 @@
1
+ ![View: the blossom of a genome assembly](http://genomer.s3.amazonaws.com/icon/view/view.jpg)
2
+
3
+ ## About
4
+
5
+ View is a plugin for the [genomer][] tool for genome projects. This plugin can
6
+ be used to generate the files required to upload a genome project. The files
7
+ generated includes sequence and annotation files. Each of the possible file
8
+ formats is documented with a [manual page][man].
9
+
10
+ [genomer]: https://github.com/michaelbarton/genomer
11
+ [man]: https://github.com/michaelbarton/genomer-plugin-view/tree/master/man
12
+
13
+ ## Usage
14
+
15
+ The following examples are taken from the [Pseudomonas fluorescens R124][r124]
16
+ genome project. These examples can be run by downloading this project and
17
+ running bundle install.
18
+
19
+ [r124]: https://github.com/michaelbarton/chromosome-pfluorescens-r124-genome
20
+
21
+ The following command can be used to generate a fasta file with associated
22
+ metadata:
23
+
24
+ genomer view fasta \
25
+ --identifier='PRJNA68653' \
26
+ --organism='Pseudomonas fluorescens' \
27
+ --strain='R124' \
28
+ --gcode='11' \
29
+ --topology='circular' \
30
+ --isolation-source='Orthoquartzite Cave Surface' \
31
+ --collection-date='17-Oct-2007' \
32
+ --completeness='Complete' \
33
+
34
+ >PRJNA68653 [organism=Pseudomonas fluorescens] [strain=R124] [gcode=11] ...
35
+ TGTTACCTGGTTCGTCCACAACGGGCCGGAATGGCCCCCGTTTTAAGAGACCGGGGATTCTAGAGAAAGC
36
+ AAGCCTTCAGGTCAATTTCCAACCAACGTTTCCTTATAAATAGATATCTGGAGCATCCAGAACCAAGACC
37
+ TTGCCTGCCAAACATAAAAATAAAGAAGGGAATTATTTAAAGCTTTTCTGTAAAGCTTATAAAAGCTAGG
38
+ GCGACAGTCTCTGTGGATAACCATGTTCAGCCCTTGTCTGGCTTGATGTACAGAGAATGACAACTACAGT
39
+ GGAAAACCGTGGTCAGCCTGTGCTGCGCTGTCGGATAACCTGTGTGTGGAACCGTCAGTTATCCACAGGC
40
+ AGGTTATCCACCGAGTTCCACCCCCAGTTGTCCAGTGCCCTCAGAGGCGGTTATCCACAGAGCTTATTCA
41
+ CACACCGTTGGTCGCCTTTTTACCGGTTAACGCATTGATTAATCATGGTCACCACACAACCTGCATGTGG
42
+ ...
43
+
44
+ The following can be used to generate an annotation table suitable for
45
+ submission to GenBank using tbl2asn.
46
+
47
+ genomer view table \
48
+ --identifier=PRJNA68653 \
49
+ --reset_locus_numbering=52 \
50
+ --prefix='I1A_' \
51
+ --generate_encoded_features='gnl|BartonUAkron|' \
52
+
53
+ >Feature PRJNA68653 annotation_table
54
+ 562 2076 gene
55
+ locus_tag I1A_000052
56
+ gene dnaA
57
+ 562 2076 CDS
58
+ protein_id gnl|BartonUAkron|I1A_000052
59
+ product DnaA
60
+ function chromosomal replication initiator protein
61
+ 2116 3219 gene
62
+ locus_tag I1A_000053
63
+ 2116 3219 CDS
64
+ protein_id gnl|BartonUAkron|I1A_000053
65
+ product DNA polymerase III, beta subunit
66
+ ...
67
+
68
+ ## Installation
69
+
70
+ Add this line to your genomer projects's Gemfile:
71
+
72
+ gem 'genomer-plugin-view'
73
+
74
+ And then execute in the project directory:
75
+
76
+ $ bundle
77
+
78
+ Run the `help` command and the summary plugin should be available:
79
+
80
+ $ genomer help
81
+ $ genomer man view
82
+
83
+ ## Copyright
84
+
85
+ Genomer copyright (c) 2010 by Michael Barton. Genomer is licensed under the MIT
86
+ license. See LICENSE.txt for further details. The Star of Bethlehem image is
87
+ used under a Creative Commons Generic 2.0 Licence. The original can be [found
88
+ on flickr.][flickr]
89
+
90
+ [flickr]: http://www.flickr.com/photos/mamjodh/4547707941/
@@ -3,10 +3,17 @@ Feature: Producing an agp view of a scaffold
3
3
  A user can use the "agp" command
4
4
  to generate an agp file of the scaffold
5
5
 
6
+ @disable-bundler
7
+ Scenario: Getting the man page for the scaffold agp view
8
+ Given I create a new genomer project
9
+ When I run `genomer man view agp`
10
+ Then the exit status should be 0
11
+ And the output should contain a valid man page
12
+ And the output should contain "GENOMER-VIEW-AGP(1)"
13
+
6
14
  @disable-bundler
7
15
  Scenario: A single contig scaffold
8
- Given I successfully run `genomer init project`
9
- And I cd to "project"
16
+ Given I create a new genomer project
10
17
  And I write to "assembly/scaffold.yml" with:
11
18
  """
12
19
  ---
@@ -19,10 +26,6 @@ Feature: Producing an agp view of a scaffold
19
26
  >contig00001
20
27
  ATGGC
21
28
  """
22
- And I append to "Gemfile" with:
23
- """
24
- gem 'genomer-plugin-view', :path => '../../../'
25
- """
26
29
  When I run `genomer view agp`
27
30
  Then the exit status should be 0
28
31
  And the output should contain:
@@ -33,8 +36,7 @@ Feature: Producing an agp view of a scaffold
33
36
 
34
37
  @disable-bundler
35
38
  Scenario: A two contig scaffold
36
- Given I successfully run `genomer init project`
37
- And I cd to "project"
39
+ Given I create a new genomer project
38
40
  And I write to "assembly/scaffold.yml" with:
39
41
  """
40
42
  ---
@@ -52,10 +54,6 @@ Feature: Producing an agp view of a scaffold
52
54
  >contig00002
53
55
  ATGGC
54
56
  """
55
- And I append to "Gemfile" with:
56
- """
57
- gem 'genomer-plugin-view', :path => '../../../'
58
- """
59
57
  When I run `genomer view agp`
60
58
  Then the exit status should be 0
61
59
  And the output should contain:
@@ -67,8 +65,7 @@ Feature: Producing an agp view of a scaffold
67
65
 
68
66
  @disable-bundler
69
67
  Scenario: A single contig scaffold with a gap
70
- Given I successfully run `genomer init project`
71
- And I cd to "project"
68
+ Given I create a new genomer project
72
69
  And I write to "assembly/scaffold.yml" with:
73
70
  """
74
71
  ---
@@ -81,10 +78,6 @@ Feature: Producing an agp view of a scaffold
81
78
  >contig00001
82
79
  ATGNNNGCG
83
80
  """
84
- And I append to "Gemfile" with:
85
- """
86
- gem 'genomer-plugin-view', :path => '../../../'
87
- """
88
81
  When I run `genomer view agp`
89
82
  Then the exit status should be 0
90
83
  And the output should contain:
@@ -97,8 +90,7 @@ Feature: Producing an agp view of a scaffold
97
90
 
98
91
  @disable-bundler
99
92
  Scenario: Two contigs scaffold containing gaps
100
- Given I successfully run `genomer init project`
101
- And I cd to "project"
93
+ Given I create a new genomer project
102
94
  And I write to "assembly/scaffold.yml" with:
103
95
  """
104
96
  ---
@@ -116,10 +108,6 @@ Feature: Producing an agp view of a scaffold
116
108
  >contig00002
117
109
  ANG
118
110
  """
119
- And I append to "Gemfile" with:
120
- """
121
- gem 'genomer-plugin-view', :path => '../../../'
122
- """
123
111
  When I run `genomer view agp`
124
112
  Then the exit status should be 0
125
113
  And the output should contain:
@@ -135,8 +123,7 @@ Feature: Producing an agp view of a scaffold
135
123
 
136
124
  @disable-bundler
137
125
  Scenario: Two contigs separated by an unresolved region
138
- Given I successfully run `genomer init project`
139
- And I cd to "project"
126
+ Given I create a new genomer project
140
127
  And I write to "assembly/scaffold.yml" with:
141
128
  """
142
129
  ---
@@ -157,10 +144,6 @@ Feature: Producing an agp view of a scaffold
157
144
  >contig00002
158
145
  ATGAT
159
146
  """
160
- And I append to "Gemfile" with:
161
- """
162
- gem 'genomer-plugin-view', :path => '../../../'
163
- """
164
147
  When I run `genomer view agp`
165
148
  Then the exit status should be 0
166
149
  And the output should contain:
@@ -173,8 +156,7 @@ Feature: Producing an agp view of a scaffold
173
156
 
174
157
  @disable-bundler
175
158
  Scenario: Two contigs separated by an unresolved region
176
- Given I successfully run `genomer init project`
177
- And I cd to "project"
159
+ Given I create a new genomer project
178
160
  And I write to "assembly/scaffold.yml" with:
179
161
  """
180
162
  ---
@@ -195,10 +177,6 @@ Feature: Producing an agp view of a scaffold
195
177
  >contig00002
196
178
  ATGATNNNNN
197
179
  """
198
- And I append to "Gemfile" with:
199
- """
200
- gem 'genomer-plugin-view', :path => '../../../'
201
- """
202
180
  When I run `genomer view agp`
203
181
  Then the exit status should be 0
204
182
  And the output should contain:
@@ -213,8 +191,7 @@ Feature: Producing an agp view of a scaffold
213
191
 
214
192
  @disable-bundler
215
193
  Scenario: A single contig scaffold with a gap filled with an insert
216
- Given I successfully run `genomer init project`
217
- And I cd to "project"
194
+ Given I create a new genomer project
218
195
  And I write to "assembly/scaffold.yml" with:
219
196
  """
220
197
  ---
@@ -234,10 +211,6 @@ Feature: Producing an agp view of a scaffold
234
211
  >insert00001
235
212
  TTT
236
213
  """
237
- And I append to "Gemfile" with:
238
- """
239
- gem 'genomer-plugin-view', :path => '../../../'
240
- """
241
214
  When I run `genomer view agp`
242
215
  Then the exit status should be 0
243
216
  And the output should contain:
@@ -248,8 +221,7 @@ Feature: Producing an agp view of a scaffold
248
221
 
249
222
  @disable-bundler
250
223
  Scenario: A single contig scaffold with a gap partially filled with an insert
251
- Given I successfully run `genomer init project`
252
- And I cd to "project"
224
+ Given I create a new genomer project
253
225
  And I write to "assembly/scaffold.yml" with:
254
226
  """
255
227
  ---
@@ -269,10 +241,6 @@ Feature: Producing an agp view of a scaffold
269
241
  >insert00001
270
242
  TTT
271
243
  """
272
- And I append to "Gemfile" with:
273
- """
274
- gem 'genomer-plugin-view', :path => '../../../'
275
- """
276
244
  When I run `genomer view agp`
277
245
  Then the exit status should be 0
278
246
  And the output should contain:
@@ -0,0 +1,12 @@
1
+ Feature: Producing different views of a genomes scaffold
2
+ In order to have required file formats of a genome scaffold
3
+ A user can use the "view" plugin
4
+ to generate file formats
5
+
6
+ @disable-bundler
7
+ Scenario: Getting the man page for the genomer view plugin
8
+ Given I create a new genomer project
9
+ When I run `genomer man view`
10
+ Then the exit status should be 0
11
+ And the output should contain a valid man page
12
+ And the output should contain "GENOMER-VIEW(1)"
@@ -0,0 +1,12 @@
1
+ Feature: Producing a fasta view of a genome scaffold
2
+ In order to have generate a fasta file of a genome scaffold
3
+ A user can use the "view fasta" plugin
4
+ to generate a fasta file
5
+
6
+ @disable-bundler
7
+ Scenario: Getting the man page for the genomer view plugin
8
+ Given I create a new genomer project
9
+ When I run `genomer man view fasta`
10
+ Then the exit status should be 0
11
+ And the output should contain a valid man page
12
+ And the output should contain "GENOMER-VIEW-FASTA(1)"
@@ -3,6 +3,14 @@ Feature: Producing a gff3 view of a scaffold's annotations
3
3
  A user can use the "gff" command
4
4
  to generate gff3 view of scaffold annotations
5
5
 
6
+ @disable-bundler
7
+ Scenario: Getting the man page for the scaffold gff view
8
+ Given I create a new genomer project
9
+ When I run `genomer man view gff`
10
+ Then the exit status should be 0
11
+ And the output should contain a valid man page
12
+ And the output should contain "GENOMER-VIEW-GFF(1)"
13
+
6
14
  @disable-bundler
7
15
  Scenario: A single annotation on a single contig
8
16
  Given I successfully run `genomer init project`
@@ -3,10 +3,17 @@ Feature: Producing a map of annotations IDs
3
3
  A user can use the "mapping" command
4
4
  to generate a list of the original and updated annotations
5
5
 
6
+ @disable-bundler
7
+ Scenario: Getting the man page for the genomer view plugin
8
+ Given I create a new genomer project
9
+ When I run `genomer man view mapping`
10
+ Then the exit status should be 0
11
+ And the output should contain a valid man page
12
+ And the output should contain "GENOMER-VIEW-MAPPING(1)"
13
+
6
14
  @disable-bundler
7
15
  Scenario: Two genes with locus tag numbering reset at the scaffold origin
8
- Given I successfully run `genomer init project`
9
- And I cd to "project"
16
+ Given I create a new genomer project
10
17
  And I write to "assembly/scaffold.yml" with:
11
18
  """
12
19
  ---
@@ -24,10 +31,6 @@ Feature: Producing a map of annotations IDs
24
31
  contig1 . gene 1 3 . + 1 ID=gene1
25
32
  contig1 . gene 4 6 . + 1 ID=gene2
26
33
  """
27
- And I append to "Gemfile" with:
28
- """
29
- gem 'genomer-plugin-view', :path => '../../../'
30
- """
31
34
  When I run `genomer view mapping --reset_locus_numbering`
32
35
  Then the exit status should be 0
33
36
  And the output should contain:
@@ -38,8 +41,7 @@ Feature: Producing a map of annotations IDs
38
41
 
39
42
  @disable-bundler
40
43
  Scenario: Two genes with locus tag numbering reset at specified start value
41
- Given I successfully run `genomer init project`
42
- And I cd to "project"
44
+ Given I create a new genomer project
43
45
  And I write to "assembly/scaffold.yml" with:
44
46
  """
45
47
  ---
@@ -57,10 +59,6 @@ Feature: Producing a map of annotations IDs
57
59
  contig1 . gene 1 3 . + 1 ID=gene1
58
60
  contig1 . gene 4 6 . + 1 ID=gene2
59
61
  """
60
- And I append to "Gemfile" with:
61
- """
62
- gem 'genomer-plugin-view', :path => '../../../'
63
- """
64
62
  When I run `genomer view mapping --reset_locus_numbering=5`
65
63
  Then the exit status should be 0
66
64
  And the output should contain:
@@ -71,8 +69,7 @@ Feature: Producing a map of annotations IDs
71
69
 
72
70
  @disable-bundler
73
71
  Scenario: Four unordered genes with locus tag reset at the scaffold origin
74
- Given I successfully run `genomer init project`
75
- And I cd to "project"
72
+ Given I create a new genomer project
76
73
  And I write to "assembly/scaffold.yml" with:
77
74
  """
78
75
  ---
@@ -92,10 +89,6 @@ Feature: Producing a map of annotations IDs
92
89
  contig1 . gene 1 3 . + 1 ID=gene1
93
90
  contig1 . gene 7 9 . + 1 ID=gene3
94
91
  """
95
- And I append to "Gemfile" with:
96
- """
97
- gem 'genomer-plugin-view', :path => '../../../'
98
- """
99
92
  When I run `genomer view mapping --reset_locus_numbering`
100
93
  Then the exit status should be 0
101
94
  And the output should contain:
@@ -108,8 +101,7 @@ Feature: Producing a map of annotations IDs
108
101
 
109
102
  @disable-bundler
110
103
  Scenario: Four genes with a prefix added to the locus tags
111
- Given I successfully run `genomer init project`
112
- And I cd to "project"
104
+ Given I create a new genomer project
113
105
  And I write to "assembly/scaffold.yml" with:
114
106
  """
115
107
  ---
@@ -129,10 +121,6 @@ Feature: Producing a map of annotations IDs
129
121
  contig1 . gene 1 3 . + 1 ID=gene1
130
122
  contig1 . gene 7 9 . + 1 ID=gene3
131
123
  """
132
- And I append to "Gemfile" with:
133
- """
134
- gem 'genomer-plugin-view', :path => '../../../'
135
- """
136
124
  When I run `genomer view mapping --prefix=pre_`
137
125
  Then the exit status should be 0
138
126
  And the output should contain:
@@ -145,8 +133,7 @@ Feature: Producing a map of annotations IDs
145
133
 
146
134
  @disable-bundler
147
135
  Scenario: Four genes prefixes and locus tag reset at the scaffold origin
148
- Given I successfully run `genomer init project`
149
- And I cd to "project"
136
+ Given I create a new genomer project
150
137
  And I write to "assembly/scaffold.yml" with:
151
138
  """
152
139
  ---
@@ -166,10 +153,6 @@ Feature: Producing a map of annotations IDs
166
153
  contig1 . gene 1 3 . + 1 ID=gene1
167
154
  contig1 . gene 7 9 . + 1 ID=gene3
168
155
  """
169
- And I append to "Gemfile" with:
170
- """
171
- gem 'genomer-plugin-view', :path => '../../../'
172
- """
173
156
  When I run `genomer view mapping --reset_locus_numbering=5 --prefix=pre_`
174
157
  Then the exit status should be 0
175
158
  And the output should contain:
@@ -0,0 +1,11 @@
1
+ When /^I create a new genomer project$/ do
2
+ step 'I successfully run `genomer init project`'
3
+ step 'I cd to "project"'
4
+ step 'I append to "Gemfile" with "gem \'genomer-plugin-view\', :path =>\'../../../\'"'
5
+ end
6
+
7
+ Then /^the output should contain a valid man page$/ do
8
+ step 'the output should not contain "md2man/roff: raw_html not implemented"'
9
+ step 'the output should not contain "\<"'
10
+ step 'the output should not contain "\>"'
11
+ end
@@ -3,6 +3,15 @@ Feature: Producing a annotation view of a scaffold
3
3
  A user can use the "table" command
4
4
  to generate the genbank annotation table format
5
5
 
6
+ @disable-bundler
7
+ Scenario: Getting the man page for the scaffold table view
8
+ Given I create a new genomer project
9
+ When I run `genomer man view table`
10
+ Then the exit status should be 0
11
+ And the output should contain a valid man page
12
+ And the output should contain "GENOMER-VIEW-TABLE(1)"
13
+
14
+
6
15
  @disable-bundler
7
16
  Scenario: Generating a table file from a single annotation
8
17
  Given I successfully run `genomer init project`
@@ -1,3 +1,3 @@
1
1
  class GenomerViewPlugin
2
- VERSION = "0.0.4"
2
+ VERSION = "0.0.5"
3
3
  end
@@ -1,5 +1,8 @@
1
+ # GENOMER-VIEW-AGP 1
2
+
3
+ ## NAME
4
+
1
5
  genomer-view-agp(1) -- Generate agp file views of scaffold
2
- ==========================================================
3
6
 
4
7
  ## SYNOPSIS
5
8
 
@@ -0,0 +1,48 @@
1
+ # GENOMER-VIEW-FASTA 1
2
+
3
+ ## NAME
4
+
5
+ genomer-view-fasta(1) -- Generate fasta view of scaffold
6
+
7
+ ## SYNOPSIS
8
+
9
+ `genomer view fasta <--contigs> [...<header-options>]`
10
+
11
+ ## DESCRIPTION
12
+
13
+ **Genomer-view-fasta** produces an fasta file of scaffold. This format provides
14
+ the complete scaffolded sequence of all contigs and gaps specified in the
15
+ **scaffold.yml** file.
16
+
17
+ **--contigs**:
18
+
19
+ Instead of generating a single sequence where gaps are represented by
20
+ N-filled regions generate a fasta file where each contiguous region of
21
+ sequence is a new fasta entry. Gap regions are not included in the fasta
22
+ file. This option is useful if submitting an incomplete genome sequence to
23
+ GenBank as the contigs are require in addition to an AGP file (see
24
+ genomer-view-agp(1)).
25
+
26
+ Additional header options can be specified. These are useful for adding
27
+ metadata to the fasta sequence. Any combination of dashes (-) and characters
28
+ may be used. See the example below for how this may be used.
29
+
30
+ ## EXAMPLES
31
+
32
+ genomer view fasta \
33
+ --contigs \
34
+ --organism='Pseudomonas fluorescens' \
35
+ --strain='R124' \
36
+ --gcode='11' \
37
+ --isolation-source='Orthoquartzite Cave Surface' \
38
+ --collection-date='17-Oct-2007' \
39
+ --completeness='Complete' \
40
+
41
+ ## BUGS
42
+
43
+ **Genomer-view** is written in Ruby and depends on the genomer gem. See the
44
+ Gemfile in the genomer-plugin-view gem install directory for version details.
45
+
46
+ ## COPYRIGHT
47
+
48
+ **Genomer** is Copyright (C) 2012 Michael Barton <http://michaelbarton.me.uk>
@@ -0,0 +1,34 @@
1
+ # GENOMER-VIEW-GFF 1
2
+
3
+ ## NAME
4
+
5
+ genomer-view-gff(1) -- Generate GFF3 view of genome scaffold annotations
6
+
7
+ ## SYNOPSIS
8
+
9
+ `genomer view gff [<annotation-options>]`
10
+
11
+ ## DESCRIPTION
12
+
13
+ **Genomer-view-gff** produces a [GFF3 formatted][gff] view of the genome
14
+ scaffold annotations. The IDs and coordinates of the annotations are updated to
15
+ reflect the locations of the source contigs in the genome scaffold. The man
16
+ page genomer-view(1) provides a listing of the \<annotation-options\> which may
17
+ be passed as arguments to update the annotations.
18
+
19
+ [gff]: http://www.sequenceontology.org/gff3.shtml
20
+
21
+ ## EXAMPLES
22
+
23
+ $ genomer view gff \
24
+ --reset_locus_numbering=52 \
25
+ --prefix='I1A_'
26
+
27
+ ## BUGS
28
+
29
+ **Genomer-view** is written in Ruby and depends on the genomer gem. See the
30
+ Gemfile in the genomer-plugin-view gem install directory for version details.
31
+
32
+ ## COPYRIGHT
33
+
34
+ **Genomer** is Copyright (C) 2012 Michael Barton <http://michaelbarton.me.uk>
@@ -0,0 +1,30 @@
1
+ # GENOMER-VIEW-MAPPING 1
2
+
3
+ ## NAME
4
+
5
+ genomer-view-mapping(1) -- Show mapping between original gene ID and new gene ID
6
+
7
+ ## SYNOPSIS
8
+
9
+ `genomer view mapping [<annotation-options>]`
10
+
11
+ ## DESCRIPTION
12
+
13
+ **Genomer-view-mapping** produces two tab-delimited columns showing the
14
+ relationship between the IDs of the original annotations and the updated genome
15
+ annotations produce by genomer. This list may be useful for updating other
16
+ documents containing gene IDS. The man page genomer-view(1) provides a listing
17
+ of the \<annotation-options\> which may be passed as arguments.
18
+
19
+ ## EXAMPLES
20
+
21
+ $ genomer view mapping
22
+
23
+ ## BUGS
24
+
25
+ **Genomer-view** is written in Ruby and depends on the genomer gem. See the
26
+ Gemfile in the genomer-plugin-view gem install directory for version details.
27
+
28
+ ## COPYRIGHT
29
+
30
+ **Genomer** is Copyright (C) 2012 Michael Barton <http://michaelbarton.me.uk>
@@ -0,0 +1,40 @@
1
+ # GENOMER-VIEW-TABLE 1
2
+
3
+ ## NAME
4
+
5
+ genomer-view-table(1) -- Generate a GenBank table view of genome scaffold annotations
6
+
7
+ ## SYNOPSIS
8
+
9
+ `genomer view table [<annotation-options>]`
10
+
11
+ ## DESCRIPTION
12
+
13
+ **Genomer-view-table** produces a table view of the genome annotations,
14
+ suitable for use with [tbl2asn][] to upload a genome assembly to GenBank. This
15
+ requires an **annotation.gff** file containing [GFF3 formatted][gff]
16
+ annotations be present in the assembly directory. The resulting IDs and
17
+ coordinates of the annotations are updated to reflect the locations of the
18
+ source contigs in the genome scaffold. The man page genomer-view(1) provides a
19
+ listing of the \<annotation-options\> which may be passed as arguments to
20
+ update the annotations.
21
+
22
+ [tbl2asn]: https://www.ncbi.nlm.nih.gov/genbank/tbl2asn2/
23
+ [gff]: http://www.sequenceontology.org/gff3.shtml
24
+
25
+ ## EXAMPLES
26
+
27
+ genomer view table \
28
+ --identifier=PRJNA68653 \
29
+ --reset_locus_numbering=52 \
30
+ --prefix='I1A_' \
31
+ --generate_encoded_features='gnl|BartonUAkron|' \
32
+
33
+ ## BUGS
34
+
35
+ **Genomer-view** is written in Ruby and depends on the genomer gem. See the
36
+ Gemfile in the genomer-plugin-view gem install directory for version details.
37
+
38
+ ## COPYRIGHT
39
+
40
+ **Genomer** is Copyright (C) 2012 Michael Barton <http://michaelbarton.me.uk>
@@ -1,9 +1,12 @@
1
+ # GENOMER-VIEW 1
2
+
3
+ ## NAME
4
+
1
5
  genomer-view(1) -- Generate file format views of scaffold and annotations
2
- =========================================================================
3
6
 
4
7
  ## SYNOPSIS
5
8
 
6
- `genomer view` <flatfile-type> [<options>...]
9
+ `genomer view` \<flatfile-type\> [\<options\>...]
7
10
 
8
11
  ## DESCRIPTION
9
12
 
@@ -13,32 +16,32 @@ the **flat-file** argument.
13
16
 
14
17
  ## OPTIONS
15
18
 
16
- * `--identifier`=[<identifier>]:
19
+ * `--identifier`=[\<identifier\>]:
17
20
  The sequence identifier to include in generated flatfile outputs.
18
21
 
19
- * `--strain`=[<strain>]:
22
+ * `--strain`=[\<strain\>]:
20
23
  The strain of the source organism.
21
24
 
22
- * `--organism`=[<organism>]:
25
+ * `--organism`=[\<organism\>]:
23
26
  The genus and species, enclosed in single quotes, of the source organism.
24
27
 
25
- * `--prefix`=[<gene-prefix>]:
26
- Prepend all ID attributes from the annotation file with <gene-prefix> in
28
+ * `--prefix`=[\<gene-prefix\>]:
29
+ Prepend all ID attributes from the annotation file with \<gene-prefix\> in
27
30
  the generated output.
28
31
 
29
32
  * `--reset_locus_numbering`:
30
33
  Reset gene ID to begin at 1 from the start of the sequence in the generated
31
34
  output file.
32
35
 
33
- * `--generate_encoded_features`=[<feature-prefix>]:
36
+ * `--generate_encoded_features`=[\<feature-prefix\>]:
34
37
  Generate corresponding 1:1 encoded feature entries from the genes entries
35
38
  in the annotation file. These will commonly be CDS entries but RNA type
36
39
  entries are also supported. The feature IDs are generated from the
37
- corresponding gene ID prefixed with the <feature-prefix>.
40
+ corresponding gene ID prefixed with the \<feature-prefix\>.
38
41
 
39
42
  ## GFF NINTH COLUMN ATTRIBUTES
40
43
 
41
- The annotation file should be in GFF3 format and contain the annotations for
44
+ The source annotation file should be in GFF3 format and contain the annotations for
42
45
  the scaffolded contigs. The default location for this file is
43
46
  **assembly/annotations.gff**. The following attributes in the GFF3 file are
44
47
  treated specially by genomer when generating flat file output.
@@ -51,7 +54,7 @@ begin with an upper case letter.
51
54
  * `ID`:
52
55
  Used to specify the ID of annotations in the output. If the
53
56
  `--generate_encoded_features` option is passed, the encoded features have
54
- an ID generated from this field prefixed with the <feature-prefix>
57
+ an ID generated from this field prefixed with the \<feature-prefix\>
55
58
  argument. This field should be unique in the annotation file.
56
59
 
57
60
  * `Name`:
@@ -96,7 +99,6 @@ section.
96
99
  **product** attributes are present. See the next section for an explanation
97
100
  of this.
98
101
 
99
-
100
102
  ### OVERLAP BETWEEN NAME, PRODUCT AND FUNCTION FIELD
101
103
 
102
104
  The genbank annotation table **product** fields may contain either a short four
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
4
+ version: 0.0.5
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2013-01-16 00:00:00.000000000 Z
12
+ date: 2013-01-25 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: genomer
@@ -135,14 +135,17 @@ files:
135
135
  - .travis.yml
136
136
  - Gemfile
137
137
  - LICENSE.txt
138
- - README.rdoc
138
+ - README.md
139
139
  - Rakefile
140
- - features/agp/generation.feature
140
+ - features/agp/core.feature
141
+ - features/core.feature
141
142
  - features/fasta/contigs.feature
143
+ - features/fasta/core.feature
142
144
  - features/fasta/single_sequence.feature
143
145
  - features/gff/core.feature
144
146
  - features/mappings/core.feature
145
147
  - features/support/env.rb
148
+ - features/support/genomer_steps.rb
146
149
  - features/table/cds_entries.feature
147
150
  - features/table/core.feature
148
151
  - features/table/feature_type.feature
@@ -156,6 +159,10 @@ files:
156
159
  - lib/genomer-plugin-view/table.rb
157
160
  - lib/genomer-plugin-view/version.rb
158
161
  - man/genomer-view-agp.ronn
162
+ - man/genomer-view-fasta.ronn
163
+ - man/genomer-view-gff.ronn
164
+ - man/genomer-view-mapping.ronn
165
+ - man/genomer-view-table.ronn
159
166
  - man/genomer-view.ronn
160
167
  - spec/genomer-view-plugin/agp_spec.rb
161
168
  - spec/genomer-view-plugin/fasta_spec.rb
@@ -180,7 +187,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
180
187
  version: '0'
181
188
  segments:
182
189
  - 0
183
- hash: 2531486959390668075
190
+ hash: -207727351507926591
184
191
  required_rubygems_version: !ruby/object:Gem::Requirement
185
192
  none: false
186
193
  requirements:
data/README.rdoc DELETED
@@ -1,19 +0,0 @@
1
- = genomer-plugin-view
2
-
3
- Description goes here.
4
-
5
- == Contributing to genomer-plugin-view
6
-
7
- * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
8
- * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
9
- * Fork the project
10
- * Start a feature/bugfix branch
11
- * Commit and push until you are happy with your contribution
12
- * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
13
- * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
14
-
15
- == Copyright
16
-
17
- Copyright (c) 2011 Michael Barton. See LICENSE.txt for
18
- further details.
19
-