DefinitionSummary¶
- class DefinitionSummary(sum_op, hed_schema, known_defs=None)[source]
Methods
Attributes
|
|
|
- static DefinitionSummary.dump_summary(filename, summary)¶
- DefinitionSummary.get_details_dict(def_gatherer)[source]¶
Return the summary-specific information in a dictionary.
- Parameters:
def_gatherer (DefExpandGatherer) – Contains the resolved dictionaries.
- Returns:
dictionary with the summary results.
- Return type:
dict
- DefinitionSummary.get_individual(summary_details, separately=True)¶
- DefinitionSummary.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.
- DefinitionSummary.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.
- DefinitionSummary.get_text_summary(individual_summaries='separate')¶
- DefinitionSummary.get_text_summary_details(include_individual=True)¶
- DefinitionSummary.merge_all_info()[source]¶
Create an Object containing the definition summary.
- Returns:
Object - the overall summary object for type_defs.
- DefinitionSummary.save(save_dir, file_formats=['.txt'], individual_summaries='separate', task_name='')¶
- DefinitionSummary.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” and a “Sidecar”.
- DefinitionSummary.DISPLAY_INDENT = ' '¶
- DefinitionSummary.INDIVIDUAL_SUMMARIES_PATH = 'individual_summaries'¶