Skip to contents

Calculate trip rate factor from model

calc_trip_rate_factor.Rd

Calculates trip rate factor from a fitted model, correcting for platform bias. Use to generate trip rate factors for weighting and reporting.

Usage

calc_trip_rate_factor(fit_dt, model, reference_platform = "diary_rmove")

Arguments

fit_dt

data.table with required columns:

  • day_id — day identifier

  • person_id — person identifier

  • diary_platform — diary platform code

  • day_group — day group label

  • num_* — trip count columns for each trip type (e.g., num_auto, num_walk) Additional columns as needed for model fitting Rows: one per person-day. Modified by reference: no (returns copy).

model

model object. Fitted trip rate model.

reference_platform

character(1). Reference platform. Default "diary_rmove".

Value

data.table. Same as input, with additional column:

  • trip_rate_factor_* — trip rate factor for each trip type (e.g., trip_rate_factor_auto)

Details

  • Copies input data to avoid reference modification.

  • Sets bias coefficients to zero for non-reference platforms.

  • Predicts trip counts with and without bias correction.

  • Calculates trip rate factor as ratio of corrected to original prediction.

  • Cleans up temporary columns and renames output.

  • Returns a copy; does not modify by reference.

Settings

None.

See also

  • extract_trip_rate_factors

  • scripts/weighting/trip_rate_factors.R

Other trip rate modeling: calculate_aggegrate_trip_rates(), extract_trip_rate_factors(), prepare_trip_adj_model_dt(), rescale_trip_rate_factors()

Examples

## Not run:
fit_dt <- data.table()
model <- lm()
#> Error in terms.formula(formula, data = data): argument is not a valid model
calc_trip_rate_factor(fit_dt, model)
#> Error: object 'model' not found
## End(Not run)