BBBikeReader.read_csv_xz

BBBikeReader.read_csv_xz(subregion_name, data_dir=None, download_confirmation_required=True, verbose=False)

Read a compressed CSV (.csv.xz) data file of a geographic region.

Parameters

  • subregion_name (str) – name of a geographic region (case-insensitive) that is available on BBBike free download server

  • data_dir (str or None) – directory where the .csv.xz data file is located/saved; if None (default), the default directory

  • download_confirmation_required (bool) – whether to ask for confirmation before starting to download a file, defaults to True

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

Returns

tabular data of the .csv.xz file

Return type

pandas.DataFrame or None

Example:

>>> import os
>>> from pyhelpers.dir import cd
>>> from pydriosm.reader import BBBikeReader

>>> bbbike_reader = BBBikeReader()

>>> region_name = 'Leeds'
>>> dat_dir = "tests"

>>> leeds_csv = bbbike_reader.read_csv_xz(region_name, dat_dir, verbose=True)
To download .csv.xz data of the following geographic region(s):
    Leeds
? [No]|Yes: yes
Downloading "Leeds.osm.csv.xz" to "tests\" ... Done.
Parsing "tests\Leeds.osm.csv.xz" ... Done.

>>> leeds_csv.head()
   type      id feature
0  node  154915    None
1  node  154916    None
2  node  154921    None
3  node  154922    None
4  node  154923    None

>>> # Delete the downloaded .csv.xz data file
>>> os.remove(cd(dat_dir, "Leeds.osm.csv.xz"))