VisionEval / VisionEval-Dev

Development version of VisionEval framework
https://visioneval.github.io/
Apache License 2.0
6 stars 32 forks source link

Missing module documentation in VETravelDemandMM package #123

Open gregorbj opened 3 years ago

gregorbj commented 3 years ago

There is insufficient documentation of the CalculateAltModeTrips, CalculateHouseholdDVMT, PredictDrivers, and PredictVehicles modules in the VETravelDemandMM package. The 'ModelParameterEstimation' section of the documentation files for these modules just refer to R script files in the 'data-raw'. The only thing that can be learned about the models from those files are the variables used in the models. The documentation needs to include more information about model structure, statistics, and goodness of fit. Modules in other packages provide examples of appropriate information to include. Without such documentation it is difficult if not impossible to really understand how the module works.

jrawbits commented 2 years ago

As of 1/2022, the VETravelDemandMM module is undergoing some updates and revisions by RSG on behalf of ODOT. This issue should be addressed in that work. @jslason