HedValidationSummary¶

class HedValidationSummary(sum_op)[source]

Methods

`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.__init__`(sum_op)
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.dump_summary`(...)
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.get_details_dict`(...)	Return the summary details from the summary_info.
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.get_empty_results`()
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.get_error_list`(...)
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.get_individual`(...)
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.get_summary`([...])	Return a summary dictionary with the information.
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.get_summary_details`([...])	Return a dictionary with the details for individual files and the overall dataset.
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.get_text_summary`([...])
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.get_text_summary_details`([...])
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.merge_all_info`()	Create a dictionary containing all the errors in the dataset.
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.save`(...)
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.update_error_location`(...)
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.update_summary`(...)	Update the summary for a given tabular input file.

Attributes

`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.DISPLAY_INDENT`
`hed.tools.remodeling.operations.summarize_hed_validation_op.HedValidationSummary.INDIVIDUAL_SUMMARIES_PATH`

HedValidationSummary.__init__(sum_op)[source]¶

static HedValidationSummary.dump_summary(filename, summary)¶

HedValidationSummary.get_details_dict(summary_info)[source]¶

Return the summary details from the summary_info.

Parameters:: summary_info (dict) – Dictionary of issues
Returns:: Same summary_info as was passed in.
Return type:: dict

static HedValidationSummary.get_empty_results()[source]¶

static HedValidationSummary.get_error_list(error_dict, count_only=False, indent=' ')[source]¶

HedValidationSummary.get_individual(summary_details, separately=True)¶

HedValidationSummary.get_summary(individual_summaries='separate')¶

Return a summary dictionary with the information.

Parameters:: individual_summaries (str) – “separate”, “consolidated”, or “none”
Returns:: dict - dictionary with “Dataset” and “Individual files” keys.

Notes: The individual_summaries value is processed as follows

“separate” individual summaries are to be in separate files
“consolidated” means that the individual summaries are in same file as overall summary
“none” means that only the overall summary is produced.

HedValidationSummary.get_summary_details(include_individual=True)¶

Return a dictionary with the details for individual files and the overall dataset.

Parameters:: include_individual (bool) – If True, summaries for individual files are included.
Returns:: dict - a dictionary with ‘Dataset’ and ‘Individual files’ keys.

Notes

The ‘Dataset’ value is either a string or a dictionary with the overall summary.
The ‘Individual files’ value is dictionary whose keys are file names and values are
their corresponding summaries.

Users are expected to provide merge_all_info and get_details_dict to support this.

HedValidationSummary.get_text_summary(individual_summaries='separate')¶

HedValidationSummary.get_text_summary_details(include_individual=True)¶

HedValidationSummary.merge_all_info()[source]¶

Create a dictionary containing all the errors in the dataset.

Returns:: dict - dictionary of issues organized into sidecar_issues and event_issues.

HedValidationSummary.save(save_dir, file_formats=['.txt'], individual_summaries='separate', task_name='')¶

static HedValidationSummary.update_error_location(error_locations, location_name, location_key, error)[source]¶

HedValidationSummary.update_summary(new_info)[source]¶

Update the summary for a given tabular input file.

Parameters:: new_info (dict) – A dictionary with the parameters needed to update a summary.

Notes

The summary needs a “name” str, a schema, a “df”, and a “Sidecar”.

HedValidationSummary.DISPLAY_INDENT = ' '¶

HedValidationSummary.INDIVIDUAL_SUMMARIES_PATH = 'individual_summaries'¶