LOR.get_keys_to_prefixes

LOR.get_keys_to_prefixes(prefixes_only=True, update=False, verbose=False)[source]

Get key to PRIDE/LOR code prefixes.

Parameters
  • prefixes_only (bool) – whether to get only prefixes, defaults to True

  • update (bool) – whether to check on update and proceed to update the package data, defaults to False

  • verbose (bool) – whether to print relevant information in console as the function runs, defaults to False

Returns

keys to LOR code prefixes

Return type

list, dict

Examples:

>>> from pyrcs.line_data import LOR

>>> lor = LOR()

>>> keys_to_prefixes_ = lor.get_keys_to_prefixes()

>>> print(keys_to_prefixes_)
['CY', 'EA', 'GW', 'LN', 'MD', 'NW', 'NZ', 'SC', 'SO', 'SW', 'XR']

>>> keys_to_prefixes_ = lor.get_keys_to_prefixes(prefixes_only=False)

>>> type(keys_to_prefixes_)
<class 'dict'>
>>> print(keys_to_prefixes_['Key to prefixes'].head())
  Prefixes                                    Name
0       CY                                   Wales
1       EA         South Eastern: East Anglia area
2       GW  Great Western (later known as Western)
3       LN                  London & North Eastern
4       MD       North West: former Midlands lines