open-contracting / data-registry

BSD 3-Clause "New" or "Revised" License
3 stars 0 forks source link

Document how we count sections #252

Open yolile opened 2 years ago

yolile commented 2 years ago

We are using

https://github.com/open-contracting/pelican-frontend/blob/e5b63869ea5614376d8da22cba921336eec74f40/backend/controller/views.py#L133-L164

for populating the "Data available" section. However, that coverage relies on the existence of ids for counting the section as present or not (or budget for planning). That means if an id is not present, that object/entry won't be counted. I think we should explain that somewhere for clarity.

jpmckinney commented 2 years ago

Is this coming from a user request, or are you anticipating a user need?

yolile commented 2 years ago

This is just me anticipating a user need (or a publisher concern).

yolile commented 2 years ago

From Guillermo:

I'm looking the general figures of the publication of Chile (see image below) and the results led me to think that we are 'counting' parties but we should use the 'count distinct' function instead'? Am I wrong? Please let me know.

And:

Yes, in my view a 'count distinct' is more useful for many purposes. Especially in 'Cantidad de proveedores de adjudicaciones:' for example, it gives you an idea of the size of the market, you can inmediatly compare it with the number of enterprises in the market, concentration, etc.

yolile commented 1 year ago

Request/feedback from a data user, to specify how we count documents and awards:

Ah okay its counting the number of award objects rather than the amount of award releases! And the same applies to “Documents”. That makes sense. I don’t know if the site is still in beta and its not a big issue but maybe its worth flagging that in the breakdown. But maybe I am unique in how I interpreted it!

cc @sabahfromlondon

yolile commented 1 year ago

Now Mariana L. also flagged that it is not clear what we are counting when we say "X number of parties" for example and that a tooltip (or similar) with the explanation could be useful

jpmckinney commented 1 year ago

We are using Bootstrap 5.2. Tooltip docs here: https://getbootstrap.com/docs/5.2/components/tooltips/

You'll need to add this after @import '~bootstrap/scss/badge';:

@import '~bootstrap/scss/tooltip';

We also use Bootstrap Vue icons. You can use the info-circle icon.