LOR.fetch_codes¶

LOR.fetch_codes(prefix=None, update=False, dump_dir=None, verbose=False, **kwargs)[source]¶

Fetches data of PRIDE/LOR codes.

Parameters:

prefix (str | None) – The prefix of LOR codes; defaults to None.
update (bool) – Whether to check for updates to the package data; defaults to False.
dump_dir (str | None) – The path to a directory where the data file will be saved; defaults to None.
verbose (bool | int) – Whether to print relevant information to the console; defaults to False.

Returns:

A dictionary containing the LOR codes.

Return type:

dict

Examples:

>>> from pyrcs.line_data import LOR  # from pyrcs import LOR
>>> lor = LOR()
>>> lor_codes_dat_cy = lor.fetch_codes(prefix='CY')
>>> type(lor_codes_dat_cy)
dict
>>> list(lor_codes_dat_cy)
['CY', 'Notes', 'Last updated date']
>>> lor_codes_dat_cy['CY']
     Code  ...                       RA Note
0   CY240  ...           Caerwent branch RA4
1  CY1540  ...  Pembroke - Pembroke Dock RA6
[2 rows x 5 columns]
>>> lor_codes_dat = lor.fetch_codes()
>>> type(lor_codes_dat)
dict
>>> list(lor_codes_dat.keys())
['LOR', 'Last updated date']
>>> l_codes = lor_codes_dat['LOR']
>>> type(l_codes)
dict
>>> list(l_codes.keys())[:5]
['CY', 'CY Notes', 'EA', 'EA Notes', 'GW']
>>> cy_codes = l_codes['CY']
>>> type(cy_codes)
pandas.core.frame.DataFrame
>>> cy_codes
     Code  ...                       RA Note
0   CY240  ...           Caerwent branch RA4
1  CY1540  ...  Pembroke - Pembroke Dock RA6
[2 rows x 5 columns]
>>> xr_codes = l_codes['XR']
>>> type(xr_codes)
dict
>>> list(xr_codes.keys())
['Current codes', 'Current codes note', 'Past codes', 'Past codes note']
>>> xr_codes['Past codes']
    Code  ... RA Note
0  XR001  ...
1  XR002  ...
[2 rows x 5 columns]
>>> xr_codes['Current codes']
    Code  ...                     RA Note
0  XR001  ...  Originally reported as RA4
1  XR002  ...  Originally reported as RA4
[2 rows x 5 columns]