Tablelayer¶
- class sds_data_model.table.TableLayer(name, df, metadata)¶
Class for simple rectangular table data.
- Parameters
name (str) –
df (pandas.core.frame.DataFrame) –
metadata (sds_data_model.metadata.Metadata) –
- Return type
None
- name¶
Name of data.
- Type
str
- df¶
pandas dataframe storing data.
- Type
DataFrame
- __init__(name, df, metadata)¶
- Parameters
name (str) –
df (pandas.core.frame.DataFrame) –
metadata (sds_data_model.metadata.Metadata) –
- Return type
None
Methods
__init__
(name, df, metadata)from_file
(data_path[, data_kwargs, ...])Load data from a file.
join
(other[, how, kwargs])Join two TableLayers using pandas merge method.
select
(columns)Select columns from TableLayer DataFrame.
where
(condition)Filter rows from TableLayer DataFrame using pandas Series object.
Attributes
- classmethod from_file(data_path, data_kwargs=None, metadata_path=None, name=None)¶
Load data from a file.
- Parameters
data_path (str) – filepath or url for data.
data_kwargs (Dict[str, Any], optional) – Additional arguments to pass to data reader. Defaults to None.
metadata_path (str, optional) – filepath or url for metadata. Defaults to None.
name (str, optional) – Name of data. Defaults to None.
- Raises
NotImplementedError – # TODO
- Returns
TableLayer object.
- Return type
_TableLayer
- join(other, how='left', kwargs=None)¶
Join two TableLayers using pandas merge method.
Examples
# TODO
- Parameters
other (_TableLayer) – # TODO
how (str) – # TODO. Defaults to “left”.
kwargs (Dict[str, Any], optional) – # TODO. Defaults to None.
self (sds_data_model.table._TableLayer) –
- Returns
# TODO
- Return type
_TableLayer
- select(columns)¶
Select columns from TableLayer DataFrame.
Examples
# TODO
- Parameters
columns (Union[str, List[str]]) – # TODO
self (sds_data_model.table._TableLayer) –
- Returns
# TODO
- Return type
_TableLayer
- where(condition)¶
Filter rows from TableLayer DataFrame using pandas Series object.
Examples
# TODO
- Parameters
condition (Series) – # TODO
self (sds_data_model.table._TableLayer) –
- Returns
# TODO
- Return type
_TableLayer