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

Two different results report files, one with ALL details and one with a summary of the data #856

Closed
yezr opened this issue Jun 24, 2024 · 6 comments · Fixed by #890
Closed
Assignees

Comments

@yezr
Copy link
Collaborator

yezr commented Jun 24, 2024

We’ve been adding more granular inactive ballot buckets to help with reporting. These granular buckets are important for reporting on RCV contests, but are starting to take a lot of real estate and grab maybe too much attention in the summary.csv. So we’re proposing to split the current summary.csv into two separate files…

summary_report.csv

Will include most of the 2.0 updates like round by round vote percentages and round by round transfers but will NOT include the split out inactive buckets. It will have just one "Inactive Ballots Total" row similar to all output before 2.0.

  • Number of undervotes in round 0
  • For each candidate, each round
    • % of total votes for each round
    • Number of ballots transferred from eliminated candidate(s) in the previous round
  • Inactive ballots in each round broken down by category
    • Overvote
    • Skipped Ranking
    • Repeat Ranking
    • Exhausted Choices
  • Per-Round winning threshold
  • RCTab version number
  • Contest Summary
  • Number to be Elected
  • Number of Candidates
  • Total Number of Ballots

detailed_report.csv

will include all of the current 2.0 updates.

detailed_report.json

summary.json will include everything and be renamed detailed_report.json.

Tabulate by Slice

Tabulate by slice files will include everything and be renamed [sliceId]_[sliceType]_detailed_report.[csv|json]

@yezr yezr added this to RCTab v2.0 Jul 8, 2024
@yezr yezr moved this to Todo in RCTab v2.0 Jul 9, 2024
@artoonie artoonie self-assigned this Sep 25, 2024
@artoonie artoonie moved this from Todo to In Progress in RCTab v2.0 Sep 27, 2024
@artoonie
Copy link
Collaborator

Should an extended summary, a simplified summary, or both be generated for slices?

@yezr
Copy link
Collaborator Author

yezr commented Sep 27, 2024

tabulate by slice file name shouldn't change and should include all the information as it currently does. So as it is right now, no updates to tab by slice are necessary

@artoonie
Copy link
Collaborator

Noted. Flagging potential confusion as x_summary_extended.csv will correspond with x_by_slice_summary.csv

@yezr
Copy link
Collaborator Author

yezr commented Sep 30, 2024

Noted. Flagging potential confusion as x_summary_extended.csv will correspond with x_by_slice_summary.csv

Noting this, can we rename the current tabulate by slice x_by_slice_summary.csv files tox_by_slice_summary_extended.csv to prevent this confusion. The original motivation for this ticket was at the contest level: for jurisdictions that don't want to have to be responsible for inactive bucket data explanations they would have an option to just post the summary file and not the summary_extended file. My thinking is that if someone is already digging into the tabulate by slice files they are going to want extended information no matter what.

@artoonie
Copy link
Collaborator

done!

@yezr yezr changed the title summary_extended.csv Two different results output files, one with ALL the data and one with a summary of the data Oct 3, 2024
@yezr yezr changed the title Two different results output files, one with ALL the data and one with a summary of the data Two different results report files, one with ALL details and one with a summary of the data Oct 3, 2024
@yezr
Copy link
Collaborator Author

yezr commented Oct 3, 2024

title and original description updated based on conversations with RCVRC HQ to rename files to detailed_report and summary_report

@github-project-automation github-project-automation bot moved this from In Review to Done in RCTab v2.0 Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants