open-contracting / cardinal-rs

Measure red flags and procurement indicators using OCDS data
https://cardinal.readthedocs.io
MIT License
9 stars 3 forks source link

Report the indicator's coverage (application, pass, fail counts and total) #26

Open jpmckinney opened 1 year ago

jpmckinney commented 1 year ago

For example, Pelican reports "pass", "fail" and "not applicable" for quality checks.

Cardinal presently only reports "fail" for red flags.

It might be useful to be able to review the N/A results.

This would involve, at minimum, storing:

Pelican also stores other metadata, like application_count and pass_count for checks that operate on arrays, and then easily accessible metadata to understand why the check failed (e.g. the paths to the fields that caused the failure).

jpmckinney commented 1 year ago

An alternative is to list which fields each indicator uses. (This would make it more an exercise for the reader.)

If we do list each field, then maybe #42 is also relevant.

jpmckinney commented 1 year ago

After discussing with @camilamila, we should report the application count, pass count, fail count and total (like Pelican does) – so that users have an idea of the indicator's coverage.

jpmckinney commented 1 year ago

Note: Whereas in Pelican, no data is excluded, with indicators, we do exclude contracting processes (e.g. direct procedures if the indicator is specific to open procedures). So, we need to count exclusions separately.