Class: Bio::KEGG::PATHWAY

Inherits:
Bio::KEGGDB show all
Includes:
Common::DblinksAsHash, Common::ModulesAsHash, Common::OrthologsAsHash, Common::PathwaysAsHash, Common::References, Common::StringsAsHash
Defined in:
lib/bio/db/kegg/pathway.rb

Overview

Description

Bio::KEGG::PATHWAY is a parser class for the KEGG PATHWAY database entry.

References

Constant Summary collapse

DELIMITER = 
RS = "\n///\n"
TAGSIZE = 
12

Instance Method Summary collapse

Methods inherited from DB

#exists?, #fetch, #get, open, #tags

Constructor Details

#initialize(entry) ⇒ PATHWAY

Creates a new Bio::KEGG::PATHWAY object.

Arguments:

  • (required) entry: (String) single entry as a string

Returns

Bio::KEGG::PATHWAY object



72
73
74
 
# File 'lib/bio/db/kegg/pathway.rb', line 72

def initialize(entry)
  super(entry, TAGSIZE)
end

Instance Method Details

#compounds_as_hash ⇒ Object Also known as: compounds

Compounds described in the COMPOUND lines.

Returns

Hash of compound ID and its definition



212
213
214
215
216
217
 
# File 'lib/bio/db/kegg/pathway.rb', line 212

def compounds_as_hash
  unless @compounds_as_hash
    @compounds_as_hash = strings_as_hash(compounds_as_strings)
  end
  @compounds_as_hash
end

#compounds_as_strings ⇒ Object

Compounds described in the COMPOUND lines.

Returns

Array containing String



205
206
207
 
# File 'lib/bio/db/kegg/pathway.rb', line 205

def compounds_as_strings
  lines_fetch('COMPOUND')
end

#dblinks_as_hash ⇒ Object Also known as: dblinks

Returns a Hash of the DB name and an Array of entry IDs in DBLINKS field.



33
 
# File 'lib/bio/db/kegg/pathway.rb', line 33

def dblinks_as_hash; super; end

#dblinks_as_strings ⇒ Object

Returns an Array of a database name and entry IDs in DBLINKS field.

Returns

Array containing String



140
141
142
 
# File 'lib/bio/db/kegg/pathway.rb', line 140

def dblinks_as_strings
  lines_fetch('DBLINKS')
end

#description ⇒ Object Also known as: definition

Description of the pathway, described in the DESCRIPTION line.

Returns

String



93
94
95
 
# File 'lib/bio/db/kegg/pathway.rb', line 93

def description
  field_fetch('DESCRIPTION')
end

#diseases_as_hash ⇒ Object Also known as: diseases

Diseases described in the DISEASE lines.

Returns

Hash of disease ID and its definition



129
130
131
132
133
134
 
# File 'lib/bio/db/kegg/pathway.rb', line 129

def diseases_as_hash
  unless @diseases_as_hash
    @diseases_as_hash = strings_as_hash(diseases_as_strings)
  end
  @diseases_as_hash
end

#diseases_as_strings ⇒ Object

Disease described in the DISEASE lines.

Returns

Array containing String



122
123
124
 
# File 'lib/bio/db/kegg/pathway.rb', line 122

def diseases_as_strings
  lines_fetch('DISEASE')
end

#entry_id ⇒ Object

Return the ID of the pathway, described in the ENTRY line.

Returns

String



79
80
81
 
# File 'lib/bio/db/kegg/pathway.rb', line 79

def entry_id
  field_fetch('ENTRY')[/\S+/]
end

#enzymes_as_strings ⇒ Object Also known as: enzymes

Enzymes described in the ENZYME lines.

Returns

Array containing String



179
180
181
 
# File 'lib/bio/db/kegg/pathway.rb', line 179

def enzymes_as_strings
  lines_fetch('ENZYME')
end

#genes_as_hash ⇒ Object Also known as: genes

Genes described in the GENE lines.

Returns

Hash of gene ID and its definition



168
169
170
171
172
173
 
# File 'lib/bio/db/kegg/pathway.rb', line 168

def genes_as_hash
  unless @genes_as_hash
    @genes_as_hash = strings_as_hash(genes_as_strings)
  end
  @genes_as_hash
end

#genes_as_strings ⇒ Object

Genes described in the GENE lines.

Returns

Array containing String



161
162
163
 
# File 'lib/bio/db/kegg/pathway.rb', line 161

def genes_as_strings
  lines_fetch('GENE')
end

#keggclass ⇒ Object

Return the name of the KEGG class, described in the CLASS line.

Returns

String



101
102
103
 
# File 'lib/bio/db/kegg/pathway.rb', line 101

def keggclass
  field_fetch('CLASS')
end

#ko_pathway ⇒ Object

KO pathway described in the KO_PATHWAY line.

Returns

String



247
248
249
 
# File 'lib/bio/db/kegg/pathway.rb', line 247

def ko_pathway
  field_fetch('KO_PATHWAY')
end

#modules_as_hash ⇒ Object Also known as: modules

Returns MODULE field as a Hash. Each key of the hash is KEGG MODULE ID, and each value is the name of the Pathway Module.

Returns

Hash



59
 
# File 'lib/bio/db/kegg/pathway.rb', line 59

def modules_as_hash; super; end

#modules_as_strings ⇒ Object

Returns MODULE field of the entry.

Returns

Array containing String objects



115
116
117
 
# File 'lib/bio/db/kegg/pathway.rb', line 115

def modules_as_strings
  lines_fetch('MODULE')
end

#name ⇒ Object

Name of the pathway, described in the NAME line.

Returns

String



86
87
88
 
# File 'lib/bio/db/kegg/pathway.rb', line 86

def name
  field_fetch('NAME')
end

#organism ⇒ Object

Organism described in the ORGANISM line.

Returns

String



154
155
156
 
# File 'lib/bio/db/kegg/pathway.rb', line 154

def organism
  field_fetch('ORGANISM')
end

#orthologs_as_hash ⇒ Object Also known as: orthologs

Returns a Hash of the orthology ID and definition in ORTHOLOGY field.



43
 
# File 'lib/bio/db/kegg/pathway.rb', line 43

def orthologs_as_hash; super; end

#orthologs_as_strings ⇒ Object

Orthologs described in the ORTHOLOGY lines.

Returns

Array containing String



147
148
149
 
# File 'lib/bio/db/kegg/pathway.rb', line 147

def orthologs_as_strings
  lines_fetch('ORTHOLOGY')
end

#pathways_as_hash ⇒ Object Also known as: pathways

Returns a Hash of the pathway ID and name in PATHWAY field.



38
 
# File 'lib/bio/db/kegg/pathway.rb', line 38

def pathways_as_hash; super; end

#pathways_as_strings ⇒ Object

Pathways described in the PATHWAY_MAP lines.

Returns

Array containing String



108
109
110
 
# File 'lib/bio/db/kegg/pathway.rb', line 108

def pathways_as_strings
  lines_fetch('PATHWAY_MAP')
end

#reactions_as_hash ⇒ Object Also known as: reactions

Reactions described in the REACTION lines.

Returns

Hash of reaction ID and its definition



194
195
196
197
198
199
 
# File 'lib/bio/db/kegg/pathway.rb', line 194

def reactions_as_hash
  unless @reactions_as_hash
    @reactions_as_hash = strings_as_hash(reactions_as_strings)
  end
  @reactions_as_hash
end

#reactions_as_strings ⇒ Object

Reactions described in the REACTION lines.

Returns

Array containing String



187
188
189
 
# File 'lib/bio/db/kegg/pathway.rb', line 187

def reactions_as_strings
  lines_fetch('REACTION')
end

#references ⇒ Object

REFERENCE – Returns contents of the REFERENCE records as an Array of Bio::Reference objects.

Returns

an Array containing Bio::Reference objects



51
 
# File 'lib/bio/db/kegg/pathway.rb', line 51

def references; super; end

#rel_pathways_as_hash ⇒ Object Also known as: rel_pathways

Returns REL_PATHWAY field as a Hash. Each key of the hash is Pathway ID, and each value is the name of the pathway.

Returns

Hash



231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/bio/db/kegg/pathway.rb', line 231

def rel_pathways_as_hash
  unless defined? @rel_pathways_as_hash then
    hash = {}
    rel_pathways_as_strings.each do |line|
      entry_id, name = line.split(/\s+/, 2)
      hash[entry_id] = name
    end
    @rel_pathways_as_hash = hash
  end
  @rel_pathways_as_hash
end

#rel_pathways_as_strings ⇒ Object

Returns REL_PATHWAY field of the entry.

Returns

Array containing String objects



223
224
225
 
# File 'lib/bio/db/kegg/pathway.rb', line 223

def rel_pathways_as_strings
  lines_fetch('REL_PATHWAY')
end