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

New command: statistics #41

Open jpmckinney opened 1 year ago

jpmckinney commented 1 year ago

It can be useful to report out some order statistics and distributions that are relevant to indicators. For example:

We might also consider reporting:

jpmckinney commented 1 year ago

Edit: Integrated this comment into #55


Thinking through how users will edit the configuration file while preparing the data:

  1. Edit configuration file with known fixes.
  2. Run prepare command.
  3. See remaining warnings in the output.
  4. Repeat 1-3 until acceptable number of warnings.

So, some (or all) of this command should be part of the prepare command.

jpmckinney commented 1 year ago

Having worked on and thought through prepare some more, we want to keep it focused on reporting things that the user can correct via configuration.

So for this issue, we can solve part of it via documentation (e.g. the example from the user research). Otherwise, it's not yet clear whether these statistics should be done in the library, in supporting notebooks, in BI, etc. So, setting as Post-MVP.

jpmckinney commented 1 year ago

Partly documented in general workflow, so removing that label. Can add more later.