BBBikeReader.read_var_osm

BBBikeReader.read_var_osm(meth, subregion_name, osm_file_format, data_dir=None, download=False, verbose=False, raise_error=True, **kwargs)[source]

Read data file of various formats (other than PBF and shapefile) for a geographic (sub)region.

Parameters:

  • meth (Callable) – name of a class method for getting (auxiliary) prepacked data

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

  • osm_file_format (str) – format (file extension) of OSM data

  • data_dir (str | None) – directory where the data file is located/saved, defaults to None; when data_dir=None, it refers to the directory specified by the corresponding downloader

  • download (bool) – whether to download/update the PBF data file of the given subregion, if it is not available at the specified path, defaults to False

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

  • raise_error (bool) – Whether to raise the provided exception; if raise_error=False (default), the error will be suppressed.

  • kwargs – [optional] parameters of the method specified by meth

Returns:

data of the specified file format

Return type:

pandas.DataFrame | None

See examples for the methods BBBikeReader.read_csv_xz() and BBBikeReader.read_geojson_xz().