Skip to contents

Retrieve the day group data table from settings for use in weighting and reporting. Use to map day-of-week groups to travel days in survey pipelines.

Usage

get_day_groups(settings)

Arguments

settings

list. Must include:

  • weight_dow_groups — mapping of day groups to travel days Modified by reference: no.

Value

data.table with columns:

  • day_group — day group name

  • travel_dow — travel day-of-week Rows: one per group.

Details

  • Extracts day group mapping from settings.

  • Returns a data.table with day group and travel day-of-week columns.

  • Returns a copy; does not modify by reference.

  • Assumes valid settings structure; errors if missing.

Settings

  • weight_dow_groups (direct): day group mapping. Default from settings.

Examples

## Not run:
get_day_groups(settings)
#> Error: object 'settings' not found
## End(Not run)