Skip to content
This repository has been archived by the owner on Nov 21, 2024. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
texadactyl committed Jul 2, 2024
2 parents 36f8c78 + 8c5dd8f commit 67c5b3d
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This project analyzes the 2024 USA Presididential Election polling data, availab

The ```ppolls2024``` executable will create directories and files as needed on-the-fly. Make sure that the standard Go $HOME/go/bin directory is in the $PATH. Similar advice for Windows users (you would know better than me).

Free advice regarding poll data: Do not bother looking at **national** poll data. It would make more sense if the national popular vote determined the leader; see https://www.brennancenter.org/our-work/research-reports/national-popular-vote-explained. But, that is not the way Presidential elections currently work in the USA. I shall say no more on this subject!
Free advice regarding poll data: Do not bother looking at **national** poll data. It would make more sense if the national popular vote determined the leader; see https://www.brennancenter.org/our-work/research-reports/national-popular-vote-explained. But, that is not the way the US Presidential elections currently work. I shall say no more on this subject!

#### Installation

Expand All @@ -31,19 +31,20 @@ ppolls2024 -l # Load the database with the downloaded data.
ppolls2024 -r tx # Get detailed report for Texas. The string "TX" is also acceptable.
ppolls2024 -r ec # Get summary report for all states. The string "EC" is also acceptable.
# Note that upshifting of the -r parameter value is performed automatically.
ppolls2024 -r ec -b # Ditto but for only the battleground states per the configuration file.
ppolls2024 -p # Get plots for all states.
```

#### Configuration

When ppolls2024 begins execution, its current configuration parameters are displayed. For example the following is a sample display of console messages for ```ppolls2024 -l```:
```
2024/06/14 09:04:40 GetConfig: PollHistoryLimit: 3
2024/06/14 09:04:40 GetConfig: TossupThreshold: 3.010000
2024/06/14 09:04:40 GetConfig: ECVAlgorithm: 2
2024/06/14 09:04:40 GetConfig: PlotWidth: 10.000000
2024/06/14 09:04:40 GetConfig: PlotHeight: 10.000000
2024/06/14 09:04:41 Loaded 275 records into the database
2024/07/02 09:30:34 GetConfig: ECVAlgorithm: 2
2024/07/02 09:30:34 GetConfig: Battleground states: AZ,GA,MI,NH,NV,PA,VA,WI
2024/07/02 09:30:34 GetConfig: PlotWidth: 10.000000
2024/07/02 09:30:34 GetConfig: PlotHeight: 10.000000
2024/07/02 09:30:34 GetConfig: PollHistoryLimit: 3
2024/07/02 09:30:34 GetConfig: TossupThreshold: 3.010000
```

The configuration file ```config.yaml``` holds the current parameter values and comments as to the meaning of each parameter.
Expand Down

0 comments on commit 67c5b3d

Please sign in to comment.