OHDSI / DataQualityDashboard

A tool to help improve data quality standards in observational data science.
https://ohdsi.github.io/DataQualityDashboard
Apache License 2.0
141 stars 93 forks source link

Link to NOT_APPLICABLE docs in Shiny app UI. #550

Open MelaniePhilofsky opened 4 months ago

MelaniePhilofsky commented 4 months ago

While reviewing our most recent, DQD v2.6, results. I came across some new checks with wording that might be misinterpreted by users reviewing the checks.

The checks have DQD STATUS = "NOT APPLICABLE".

The error message states the data are "missing". This is a little nit picky, but missing Implies the data should be there. However, these fields are not required. And we have purposely not populated the field (i.e. Payer_Plan_Period.sponsor_concept_id) since we do not have these data. I would suggest "missing" be replace by "not present".

katy-sadowski commented 4 months ago

Hi @MelaniePhilofsky ! Could you please clarify which error message you're referring to?

The NOT_APPLICABLE status is designed for the scenario you're describing - these are checks that can be disregarded because a column or table is not populated. Docs have more info: https://ohdsi.github.io/DataQualityDashboard/articles/CheckStatusDefinitions.html#not-applicable

MelaniePhilofsky commented 4 months ago

Thank you for the quick reply! The documentation is very helpful. I’ll close this issue since the documentation fully explains the STATUS = ‘NOT APPLICABLE”.Is there a way we can link each DQD check result with the documentation explaining the error?Cheers,MelanieOn May 25, 2024, at 9:36 AM, Katy Sadowski @.***> wrote: Hi @MelaniePhilofsky ! Could you please clarify which error message you're referring to? The NOT_APPLICABLE status is designed for the scenario you're describing - these are checks that can be disregarded because a column or table is not populated. Docs have more info: https://ohdsi.github.io/DataQualityDashboard/articles/CheckStatusDefinitions.html#not-applicable

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: @.***>

katy-sadowski commented 4 months ago

That's a good idea, Melanie. I'll keep this issue open and pull it into work for the upcoming release which is focused on documentation.