extract_logsums: Extract destination choice logsums

View source: R/logsums.R

extract_logsumsR Documentation

Extract destination choice logsums

Description

The logsums are provided at production-side beta zones, by purpose and market segment. This function aggregates market segments by averaging and purposes by summation (sum of all purpose logsums faced by the average user).

Usage

extract_logsums(
  db,
  scope = NULL,
  purposes = NULL,
  agg_var = "AZONE",
  index_year = 2000
)

Arguments

db

The scenario sqlite database.

scope

a dplyr::filtering criteria to limit the scope of the dataframe

purposes

a vector of trip purposes to include in the average logsum.

agg_var

The region variable on which to aggregate logsums.

index_year

[Optional] index year that should be used as the starting year for data or plots;

Value

a data_frame


pbsag/swimr documentation built on July 4, 2025, 12:10 p.m.