Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate scan_data() elements into validation reports #492

Open
kamilsi opened this issue Oct 16, 2023 · 0 comments
Open

Integrate scan_data() elements into validation reports #492

kamilsi opened this issue Oct 16, 2023 · 0 comments

Comments

@kamilsi
Copy link

kamilsi commented Oct 16, 2023

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.

@rich-iannone rich-iannone modified the milestones: v0.12.0, v0.13.0 Feb 20, 2024
@rich-iannone rich-iannone changed the title Integrate scan_data Elements into Validation Reports Integrate scan_data() elements into validation reports Feb 20, 2024
@rich-iannone rich-iannone modified the milestones: v0.13.0, v0.14.0 Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants