data.dataset package¶

Subpackages¶

Defines the class that represents a dataset

class data.dataset.dataset.DataSetDefinition(definition=None)¶

Bases: object

Represents the dataset definition

add_global_parameter(parameter)¶

Adds a new global parameter to the dataset definition

Parameters:	parameter (`data.interface.parameter.Parameter`) – The parameter to add

add_global_value(value)¶

Adds the data value

Parameters:	value (`data.data.value.DataValue`) – The data value to add

:raises data.data.exceptions.InvalidData: If the value is a duplicate

add_parameter(parameter)¶

Adds a new parameter to the dataset definition

Parameters:	parameter (`data.interface.parameter.Parameter`) – The parameter to add

get_dict()¶

Returns the internal dictionary that represents this datasets definition

Returns:	The internal dictionary
Return type:	dict

get_parameter(parameter_name)¶

Retrieves the specified parameter from the dataset definition

Returns:	The specified parameter of the dataset definition
Return type:	`data.interface.parameter.Parameter`

get_parameters()¶

Retrieves the list of parameter keys from the dataset definition

Returns:	The list of parameter keys
Return type:	[str]

validate(data=None)¶

Validates the dataset definition

Returns:	A list of warnings discovered during validation
Return type:	:class:[util.validation.ValidationWarning]