dabreegster / odjitter

Disaggregate zone-based origin/destination data to specific points
Apache License 2.0
12 stars 6 forks source link

Rename arguments? #9

Closed Robinlovelace closed 2 years ago

Robinlovelace commented 2 years ago

Currently there are two potentially misleading argument names:

## OPTIONS:
##         --all-key <ALL_KEY>
##             Which column in the OD row specifies the total number of trips to disaggregate?
##             [default: all]
## 
...
## 
##         --max-per-od <MAX_PER_OD>
##             What's the maximum number of trips per output OD row that's allowed? If an input OD row
##             contains less than this, it will appear in the output without transformation. Otherwise,
##             the input row is repeated until the sum matches the original value, but each output row
##             obeys this maximum

Misleading because it's too specific. Really the first is the name of the column used to determine if an OD pair should be disaggregated and into how many 'sub-OD pairs'. The second can be described simply as the disaggregation threshold. I'm not precious about this and open minded to other options including keeping it as is. Plan to put in a PR as the basis for informed conversation on this.