romcomma.base.classes.Data

class Data(folder, **kwargs)

Bases: ABC

Abstraction of Model Data. Essentially a NamedTuple of Frames in a folder. Most Data methods are simple wrappers for annoyingly underscored methods of NamedTuple.

Parameters:

• folder (Path | str) –

• kwargs (Data.Matrix) –

__init__(folder, **kwargs)

Data Constructor.

Parameters:

• folder (Path | str) – The folder to record the data. Must exist.

• **kwargs (Frame | DataFrame | ndarray | Tensor) – Initial pairs of NamedTuple fields, precisely as in NamedTuple(**kwargs). Missing fields receive their defaults, so Data(folder) is the default parameter set.

Methods

__init__(folder, **kwargs)	Data Constructor.
asdict()
copy(src_folder, dst_folder)	Returns a copy of src_folder at dst_folder, deleting anything existing at the destination.
delete(folder)	Returns a non-existent folder.
empty(folder)	Returns an empty folder.
make(iterable)
move(dst_folder)	Move self to dst_folder.
read(folder, **kwargs)	Read Data from folder.
replace(**kwargs)

Attributes

Matrix
field_defaults
fields
folder
frames

class NamedTuple(NotImplemented=array([['NotImplemented']], dtype='<U14'))

Bases: NamedTuple

A NamedTuple of data. Must be overridden.

Parameters:

NotImplemented (Frame | DataFrame | ndarray | Tensor) –

NotImplemented: Frame | DataFrame | ndarray | Tensor

NamedTuple can have any number of members.

count(value, /)

Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

move(dst_folder)

Move self to dst_folder.

Parameters:

dst_folder (Path | str) – The folder to move to. If this exists, it will be emptied.

Return type:

Data

Returns: self for chaining calls.

classmethod read(folder, **kwargs)

Read Data from folder.

Parameters:

• folder (Path | str) – The folder to record the data. Must exist

• **kwargs (Frame | DataFrame | ndarray | Tensor) – key=ordinate initial pairs of NamedTuple fields, precisely as in NamedTuple(**kwargs). Missing fields receive their defaults, so Data(folder) is the default Data.

Return type:

Data

Returns: The Data stored in folder.

static delete(folder)

Returns a non-existent folder.

Parameters:

folder (Path | str) –

Return type:

Path

static empty(folder)

Returns an empty folder.

Parameters:

folder (Path | str) –

Return type:

Path

static copy(src_folder, dst_folder)

Returns a copy of src_folder at dst_folder, deleting anything existing at the destination.

Parameters:

• src_folder (Path | str) –

• dst_folder (Path | str) –

Return type:

Path