set_fare_structure: Set the fare structure used when calculating transit fares

View source: R/set.R

set_fare_structureR Documentation

Set the fare structure used when calculating transit fares

Description

Sets the fare structure used by our "generic" fare calculator. A value of NULL is passed to fare_structure by the upstream routing and accessibility functions when fares are not to be calculated.

Usage

set_fare_structure(r5r_core, fare_structure)

Arguments

r5r_core

An object to connect with the R5 routing engine, created with setup_r5().

fare_structure

A fare structure object, following the convention set in setup_fare_structure(). This object describes how transit fares should be calculated. Please see the fare structure vignette to understand how this object is structured: vignette("fare_structure", package = "r5r").

Value

Invisibly returns TRUE.

See Also

Other setting functions: set_breakdown(), set_cutoffs(), set_expanded_travel_times(), set_fare_cutoffs(), set_max_fare(), set_max_lts(), set_max_rides(), set_monte_carlo_draws(), set_n_threads(), set_output_dir(), set_percentiles(), set_progress(), set_speed(), set_suboptimal_minutes(), set_time_window(), set_verbose()


r5r documentation built on May 29, 2024, 7:30 a.m.