Table

from neo4j_runway.utils.data import Table

A container for a Pandas DataFrame and its associated information.

Attributes
----------
name : str
    The name of the data file.
file_path : str
    The full file path to the file.
dataframe : pd.DataFrame
    The data in Pandas DataFrame format.
general_description : str
    A general description of the data.
data_dictionary : Dict[str, str], optional
    A description of each column that is available for
    data modeling. Only columns identified here will be
    considered for inclusion in the data model.
use_cases : Optional[List[str]], optional
    Any use cases that the graph data model should
    address.
discovery_content : Optional[DiscoveryContent], optional
    Any insights gathered about the data. This is
    contained within the DiscoveryContent class.
discovery : str
    The discovery generated by the Discovery module and
    contained in the `discovery` attribute of
    `discovery_content`.

Class Methods

init

A container for a Pandas DataFrame and its associated information.

Parameters
----------
name : str
    The name of the data file.
file_path : str
    The full file path to the file.
dataframe : pd.DataFrame
    The data in Pandas DataFrame format.
general_description : str
    A general description of the data, by default None
data_dictionary : Dict[str, str], optional
    A description of each column that is available for
    data modeling, by default dict()
use_cases : Optional[List[str]], optional
    Any use cases that the graph data model should
    address, by default None
discovery_content : Optional[DiscoveryContent], optional
Any insights gathered about the data. This is contained
    within the DiscoveryContent class. By default None

Class Properties

discovery

The discovery generated by the Discovery module. Does not contain Pandas summaries.

Returns
-------
str
    Discovery.