Skip to content

Integrate scan_data() elements into validation reports #492

@kamilsi

Description

@kamilsi

I recently attended a workshop where the functionalities of this package were discussed. One question that came up was whether elements from scan_data, such as the map of missing data, could be integrated into the final validation reports. Currently, this feature is not available, but I believe it would add considerable value to the reporting workflow.

Motivation:
The scan_data function provides a comprehensive overview of the data, offering insights into various aspects like variable statistics, interactions, correlations, and missing values. Integrating some of this rich contextual information into the final validation report would make the report much more informative. Users would benefit from having a single, consolidated document that provides both validation results and data quality metrics.

Suggested Implementation:
I envision an optional parameter within the validation function report where users could specify which sections of the scan_data report they want to include in the final validation report. For instance:

agent_3 %>% 
  get_agent_report(include_scan_data_sections = c("O", "M"))  # Include 'Overview' and 'Missing Values' from scan_data
)

This approach would give users the flexibility to choose what additional information they find relevant for their specific use case.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions