1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
from cogent.util.table import Table
from cogent.db.ensembl.util import CaseInsensitiveString
__author__ = "Gavin Huttley"
__copyright__ = "Copyright 2007, The Cogent Project"
__credits__ = ["Gavin Huttley"]
__license__ = "GPL"
__version__ = "1.4.1"
__maintainer__ = "Gavin Huttley"
__email__ = "Gavin.Huttley@anu.edu.au"
__status__ = "alpha"
_species_common_map = [['Aedes aegypti', 'A.aegypti'],
['Anolis carolinensis', 'Anole lizard'],
['Anopheles gambiae', 'Mosquito'],
['Apis mellifera', 'Honeybee'],
['Bos taurus', 'Cow'],
['Caenorhabditis briggsae', 'C.briggsae'],
['Caenorhabditis elegans', 'C.elegans'],
['Canis familiaris', 'Dog'],
['Cavia porcellus', 'Guinea Pig'],
['Choloepus hoffmanni', 'Sloth'],
['Ciona intestinalis', 'C.intestinalis'],
['Ciona savignyi', 'C.savignyi'],
['Danio rerio', 'Zebrafish'],
['Dasypus novemcinctus', 'Armadillo'],
['Dipodomys ordii', 'Kangaroo rat'],
['Drosophila melanogaster', 'Fly'],
['Echinops telfairi', 'Tenrec'],
['Equus caballus', 'Horse'],
['Erinaceus europaeus', 'Hedgehog'],
['Felis catus', 'Cat'],
['Gallus gallus', 'Chicken'],
['Gasterosteus aculeatus', 'Stickleback'],
['Gorilla gorilla', 'Gorilla'],
['Homo sapiens', 'Human'],
['Loxodonta africana', 'Elephant'],
['Macaca mulatta', 'Macaque'],
['Macropus eugenii', 'Wallaby'],
['Microcebus murinus', 'Mouse lemur'],
['Monodelphis domestica', 'Opossum'],
['Mus musculus', 'Mouse'],
['Myotis lucifugus', 'Microbat'],
['Ochotona princeps', 'Pika'],
['Ornithorhynchus anatinus', 'Platypus'],
['Oryctolagus cuniculus', 'Rabbit'],
['Oryzias latipes', 'Medaka'],
['Otolemur garnettii', 'Bushbaby'],
['Pan troglodytes', 'Chimp'],
['Petromyzon marinus', 'Lamprey'],
['Pongo pygmaeus', 'Orangutan'],
['Procavia capensis', 'Rock hyrax'],
['Pteropus vampyrus', 'Flying fox'],
['Rattus norvegicus', 'Rat'],
['Saccharomyces cerevisiae', 'S.cerevisiae'],
['Sorex araneus', 'Shrew'],
['Spermophilus tridecemlineatus', 'Ground Squirrel'],
['Sus scrofa', 'Pig'],
['Sus scrofa map', 'Pig'],
['Taeniopygia guttata', 'Zebra finch'],
['Takifugu rubripes', 'Fugu'],
['Tarsius syrichta', 'Tarsier'],
['Tetraodon nigroviridis', 'Tetraodon'],
['Tupaia belangeri', 'Tree Shrew'],
['Tursiops truncatus', 'Bottlenose dolphin'],
['Vicugna pacos', 'Alpaca'],
['Xenopus tropicalis', 'Xenopus']]
class SpeciesNameMap(dict):
"""mapping between common names and latin names"""
def __init__(self, species_common = _species_common_map):
"""provides latin name:common name mappings"""
self._species_common = {}
self._common_species = {}
self._species_ensembl = {}
self._ensembl_species = {}
for species_name, common_name in species_common:
self.amendSpecies(CaseInsensitiveString(species_name),
CaseInsensitiveString(common_name))
def __str__(self):
rows = []
for common in self._common_species:
species = self._common_species[common]
ensembl = self._species_ensembl[species]
rows += [[common, species, ensembl]]
return str(Table(['Common Name', 'Species Name', 'Ensembl Db Prefix'],
rows=rows, space=2).sorted())
def __repr__(self):
return 'Available species: %s' % ("'"+\
"'; '".join(self._common_species.keys())+"'")
def getCommonName(self, name):
"""returns the common name for the given name (which can be either a
species name or the ensembl version)"""
name = CaseInsensitiveString(name)
if name in self._ensembl_species:
name = self._ensembl_species[name]
if name in self._species_common:
common_name = self._species_common[name]
elif name in self._common_species:
common_name = name
else:
raise RuntimeError("Unknown species: %s" % name)
return str(common_name)
def getSpeciesName(self, name, level='ignore'):
"""returns the species name for the given common name"""
name = CaseInsensitiveString(name)
if name in self._species_common:
return str(name)
species_name = None
level = level.lower().strip()
name = name
for data in [self._common_species, self._ensembl_species]:
if name in data:
species_name = data[name]
if species_name is None:
msg = "Unknown common name: %s" % name
if level == 'raise':
raise RuntimeError(msg)
elif level == 'warn':
print "WARN: %s" % msg
return str(species_name)
def getSpeciesNames(self):
"""returns the list of species names"""
names = self._species_common.keys()
names.sort()
return [str(n) for n in names]
def getEnsemblDbPrefix(self, name):
"""returns a string of the species name in the format used by
ensembl"""
name = CaseInsensitiveString(name)
if name in self._common_species:
name = self._common_species[name]
try:
species_name = self.getSpeciesName(name, level='raise')
except RuntimeError:
if name not in self._species_common:
raise RuntimeError("Unknown name %s" % name)
species_name = name
return str(species_name.lower().replace(" ","_"))
def _purge_species(self, species_name):
"""removes a species record"""
species_name = CaseInsensitiveString(species_name)
if not species_name in self._species_common:
return
common_name = self._species_common.pop(species_name)
ensembl_name= self._species_ensembl.pop(species_name)
self._ensembl_species.pop(ensembl_name)
self._common_species.pop(common_name)
def amendSpecies(self, species_name, common_name):
"""add a new species, and common name"""
species_name = CaseInsensitiveString(species_name)
common_name = CaseInsensitiveString(common_name)
assert "_" not in species_name,\
"'_' in species_name, not a Latin name?"
self._purge_species(species_name) # remove if existing
self._species_common[species_name] = common_name
self._common_species[common_name] = species_name
ensembl_name = species_name.lower().replace(" ","_")
self._species_ensembl[species_name] = ensembl_name
self._ensembl_species[ensembl_name] = species_name
return
Species = SpeciesNameMap()
|
