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

Implement page summary template and update round analysis template. #17

Merged
merged 3 commits into from
Mar 18, 2024

Conversation

Faster319
Copy link
Contributor

These templates are used alongside the changes introduced from #15 to generate two webpages to visualise the results of the election that was run. An example election was ran and the output files can be found here analysis_and_summary_example.zip.

Page Summary

  • This page will contain the results and general statistics regarding the election that was ran.
  • Includes a chart which displays how the budget was allocated across the selected projects.
  • Includes a summary table which displays what project got selected in each round, along with a chart that demonstrates how much funding the supporters of the project had in comparison to how much they could've had had they not spent on previously selected projects.
  • The user is able to click on a row to expand and reveal details regarding the project and the round.
    • A hyperlink is also shown which can open the round analysis page on the specific round the user expanded the row on.
    • Dynamically generated sample explanations can be seen which describes why a certain project got selected/rejected as well as the funding lost to all other projects.

Round Analysis

  • Page now loads a lot faster.
  • Round analysis page has been updated to incorporate a bootstrap style.
  • Annotations have been added alongside the visualisations which include dynamic explanations for them.
  • Larger charts such as the chord diagram now show the five most common projects, therefore, it can be inferred more intuitively.
  • Navbar link to summary page now works and vice versa.

Please note that some sample explanations and UI still require finalising, further, the currency shown is currently hardcoded in place.

Please see the attached GIFs from the page summary and round analysis page.
page summary
round analysis

Faster319 and others added 3 commits March 14, 2024 15:34
Implemented the page summary template. This page will contain the results and general statistics regarding the election that was ran.

Most notably, it includes a chart which displays how the budget was allocated across the selected projects. Further, a summary table which displays what project got selected in each round, along with a chart that demonstrates how much funding the supporters of the project had in comparison to how much they could've had had they did not spent on previously selected projects. Finally, the user is able to click on a row to expand and reveal details regarding the round and project. For example, a hyperlink which will open the round analysis page on the specific round the user expanded the row on and sample explanations which describes why a certain project got selected/rejected as well as the funding lost to all other projects.

Modified visualisation.py in order to retrieve the variables necessary for the page summary and adjusted test file accordingly to avoid errors.
…ltiple file paths. Renamed and fixed header links between summary page and round analysis. Round analysis page uses actual project names
Copy link

codecov bot commented Mar 18, 2024

Codecov Report

Attention: Patch coverage is 97.14286% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 93.40%. Comparing base (1a09a5e) to head (3b58c40).

Files Patch % Lines
pabutools/visualisation/visualisation.py 97.14% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #17      +/-   ##
==========================================
+ Coverage   93.38%   93.40%   +0.02%     
==========================================
  Files          43       43              
  Lines        2871     2898      +27     
==========================================
+ Hits         2681     2707      +26     
- Misses        190      191       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Simon-Rey Simon-Rey merged commit 1ef92fc into COMSOC-Community:main Mar 18, 2024
5 checks passed
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

Successfully merging this pull request may close these issues.

4 participants