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

Allow 'total' (or 'All') as a population name? #491

Open
RomeshA opened this issue Nov 6, 2023 · 1 comment
Open

Allow 'total' (or 'All') as a population name? #491

RomeshA opened this issue Nov 6, 2023 · 1 comment

Comments

@RomeshA
Copy link
Contributor

RomeshA commented Nov 6, 2023

'Total' could sometimes be a useful population name to have - same with 'all'. The reason these are not permitted is because they are used by PlotData as aggregations. 'All' is shorthand for selecting all populations, 'Total' is shorthand for summing all populations. However, currently None is treated the same as 'all' for this purpose. If 'all' was instead used as a shorthand for summing the populations, the keyword 'total' would be freed up. Alternatively, we could use 'total' instead of 'all', but in #490 it would be clearer if a single row entry in the databook was 'all' rather than 'total' because it's clearer how this relates to the values used in each individual population.

This would be a breaking change so would be slated for a major release

@RomeshA
Copy link
Contributor Author

RomeshA commented Feb 6, 2024

#490 means that 'All' cannot be used for this purpose any more, but 'total' could still potentially work. It might not always be clear to users though how the 'total' value is used though (considering that 'all' does now have implications for the simulations as the values are inserted as defaults - would users expect that a 'total' value is somehow disaggregated over populations? Or just that it's used for plotting?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant