SummarizeDefinitionsOp

class SummarizeDefinitionsOp(parameters)

Summarize the type_defs in the dataset.

Required remodeling parameters:

• summary_name (str): The name of the summary.

• summary_filename (str): Base filename of the summary.

The purpose is to produce a summary of the values in a tabular file.

Methods

hed.tools.remodeling.operations.summarize_definitions_op.SummarizeDefinitionsOp.__init__(...)	Constructor for the summarize column values operation.
hed.tools.remodeling.operations.summarize_definitions_op.SummarizeDefinitionsOp.check_parameters(...)	Verify that the parameters meet the operation specification.
hed.tools.remodeling.operations.summarize_definitions_op.SummarizeDefinitionsOp.do_op(...)	Create summaries of type_defs

Attributes

hed.tools.remodeling.operations.summarize_definitions_op.SummarizeDefinitionsOp.PARAMS
hed.tools.remodeling.operations.summarize_definitions_op.SummarizeDefinitionsOp.SUMMARY_TYPE

SummarizeDefinitionsOp.__init__(parameters)

Constructor for the summarize column values operation.

Parameters:

parameters (dict) – Dictionary with the parameter values for required and optional parameters.

Raises:

• KeyError –

  • If a required parameter is missing.

  • If an unexpected parameter is provided.

• TypeError –

  • If a parameter has the wrong type.

SummarizeDefinitionsOp.check_parameters(parameters)

Verify that the parameters meet the operation specification.

Parameters:

parameters (dict) – Dictionary of parameters for this operation.

Raises:

• KeyError –

  • If a required parameter is missing.

  • If an unexpected parameter is provided.

• TypeError –

  • If a parameter has the wrong type.

SummarizeDefinitionsOp.do_op(dispatcher, df, name, sidecar=None)

Create summaries of type_defs

Parameters:

• dispatcher (Dispatcher) – Manages the operation I/O.

• df (DataFrame) – The DataFrame to be remodeled.

• name (str) – Unique identifier for the dataframe – often the original file path.

• sidecar (Sidecar or file-like) – Only needed for HED operations.

Returns:

a copy of df

Return type:

DataFrame

Side-effect:

Updates the relevant summary.

SummarizeDefinitionsOp.PARAMS = {'operation': 'summarize_definitions', 'optional_parameters': {'append_timecode': <class 'bool'>}, 'required_parameters': {'summary_filename': <class 'str'>, 'summary_name': <class 'str'>}}

SummarizeDefinitionsOp.SUMMARY_TYPE = 'type_defs'