LOR.fetch_elr_lor_converter¶

LOR.fetch_elr_lor_converter(update=False, dump_dir=None, verbose=False)[source]¶

Fetches the data of ELR/LOR converter.

Parameters:

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 data of ELR/LOR converter.

Return type:

dict

Examples:

>>> from pyrcs.line_data import LOR  # from pyrcs import LOR
>>> lor = LOR()
>>> elr_lor_conv = lor.fetch_elr_lor_converter()
>>> type(elr_lor_conv)
dict
>>> list(elr_lor_conv.keys())
['ELR/LOR converter', 'Last updated date']
>>> elr_loc_conv_data = elr_lor_conv['ELR/LOR converter']
>>> type(elr_loc_conv_data)
pandas.core.frame.DataFrame
>>> elr_loc_conv_data.head()
    ELR  ...                                            LOR_URL
0   AAV  ...  http://www.railwaycodes.org.uk/pride/pridesw.s...
1   ABD  ...  http://www.railwaycodes.org.uk/pride/pridegw.s...
2   ABE  ...  http://www.railwaycodes.org.uk/pride/prideln.s...
3  ABE1  ...  http://www.railwaycodes.org.uk/pride/prideln.s...
4  ABE2  ...  http://www.railwaycodes.org.uk/pride/prideln.s...
[5 rows x 6 columns]