Dataset¶

class leveropen.dataset.Dataset(uuid: str, name: str, released_on: datetime.datetime, processed_on: datetime.datetime, collection: str, topic: str, link: str, license: dict, datetimes: List[dict], locations: List[dict], categories: List[dict], series_url: str, client: leveropen.client.Client)¶

Represents a Lever Open dataset

Parameters

uuid (str) – Unique ID of the dataset
name (str) – Name of the dataset
released_on (datetime.datetime) – Most recent released date of the data
processed_on (datetime.datetime) – Most recent date that Lever Open processed the data
collection (str) – Collection to which the dataset belongs
topic (str) – Topic to which the dataset belongs
link (str) – URL
license (dict) – {‘name’: ‘License name’, ‘url’: ‘link-to-license’}
datetimes (List[dict]) – e.g. [{'name': 'Month', 'range': ['January 1997', 'December 2020']}, ...]
locations (List[dict]) – e.g. [{'type': 'Country', 'name', 'UK'}, ...]
categories (List[dict]) – e.g. [{'type': 'Sector', 'name': 'Construction'}, ...]
series_url (str) – URL link to series data
client (leveropen.client.Client()) – Lever Open API Client

get_categories() → pandas.core.frame.DataFrame¶

Returns: Type and Categories
Return type: pandas.DataFrame
Example

>>> self.get_categories()
         type                 name
    Sector         Construction
    Sector             Services
Adjustment  Seasonally adjusted
    Sector           Production
     Total          Monthly GDP
    Sector          Agriculture

get_metadata() → pandas.core.series.Series¶

Returns: Key information about the dataset
Return type: pandas.Series
Example

>>> metadata = self.get_metadata()
>>> metadata.head()
name                                              Example Dataset
topic                                                     Economy
collection                           Gross Domestic Product (GDP)
released_on                                   2021-02-12 00:00:00
processed_on                                  2021-03-05 00:00:00
Name: example-dataset-uuid, dtype: object

get_series(load: bool = True) → List[leveropen.l_series.LSeries]¶

Parameters: load – if 'True' then self.series_objects is set
Returns: all series names on the dataset
Return type: List[LSeries]
Example

>>> self.get_series()
[
     LSeries(
         uuid='uuid-of-series-one',
         name='Series-Name-One',
         units='Count',
         magnitude=1,
         ...
     ),
     LSeries(
         uuid='uuid-of-series-two',
         name='Series-Name-Two',
         units='Count',
         magnitude=1,
         ...
     )
]

get_series_by_name(name: str) → leveropen.l_series.LSeries ¶

Parameters: name – the name of the series leveropen.l_series.LSeries.name
Returns: LSeries
Example

>>> self.get_series_by_name(name='Series-Name-One')
LSeries(
    uuid='uuid-of-series-one',
    name='Series-Name-One',
    units='Count',
    magnitude=1,
    ...
)

get_series_by_name_containing(name_containing_string: str) → List[leveropen.l_series.LSeries]¶

Parameters: name_containing_string (str) – substring for which to find in series names
Returns: list of Lever Open Series
Return type: List[LSeries]
Example

>>> self.get_series_by_name_containing(
...     name_containing_string='Series-Name'
... )
[
     LSeries(
         uuid='uuid-of-series-one',
         name='Series-Name-One',
         units='Count',
         magnitude=1,
         ...
     ),
     LSeries(
         uuid='uuid-of-series-two',
         name='Series-Name-Two',
         units='Count',
         magnitude=1,
         ...
     )
]

get_series_by_uuid(uuid: str) → leveropen.l_series.LSeries ¶

Parameters: uuid – the uuid of the series leveropen.l_series.LSeries.uuid
Returns: LSeries
Example

>>> self.get_series_by_uuid(uuid='uuid-of-series-one')
LSeries(
    uuid='uuid-of-series-one',
    name='Series-Name-One',
    units='Count',
    magnitude=1,
    ...
)

get_series_names_and_uuids() → pandas.core.frame.DataFrame¶

Returns: all series name and their uuid
Return type: pandas.DataFrame
Example

>>> self.get_series_names_and_uuids()
               name                uuid
0   Series-Name-One  uuid-of-series-one
1   Series-Name-Two  uuid-of-series-Two
2               ...                 ...
n     Series-Name-N    uuid-of-series-N