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

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
texadactyl authored Jul 2, 2024
1 parent 3cb5cad commit 8c5dd8f
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 8c5dd8f

Please sign in to comment.