Creates a basic fare structure that describes how transit fares should be
pareto_frontier(). This fare structure can be
manually edited and adjusted to the existing rules in your study area, as
long as they stick to some basic premises. Please see fare structure
vignette for more information on how the fare structure works:
vignette("fare_structure", package = "r5r").
setup_fare_structure( r5r_core, base_fare, by = "MODE", debug_path = NULL, debug_info = NULL )
An object to connect with the R5 routing engine, created with
A numeric. A base value used to populate the fare structure.
A string. Describes how
fare_types (a classification we created
to assign fares to different routes) are distributed among routes.
Possible values are
MODE is used when
the mode is what determines the price of a route (e.g. if all the buses of
a given city cost $5).
AGENCY is used when the agency that operates each
route is what determines its price (i.e. when two different routes/modes
operated by a single agency cost the same; note that you can also use
AGENCY_NAME, if the agency_ids listed in your GTFS cannot be easily
GENERIC is used when all the routes cost the same. Please
note that this classification can later be edited to better suit your
needs (when, for example, two types of buses cost the same, but one offers
discounts after riding the subway and the other one doesn't), but this
parameter may save you some work.
Either a path to a
.csv file or
default), fare debugging capabilities are disabled - i.e. there's no way
to check if the fare calculation is correct. When a path is provided,
r5r saves different itineraries and their respective fares to the
specified file. How each itinerary is described is controlled by
Either a string (when
debug_path is a path) or
(the default). Doesn't have any effect if
NULL. When a
string, accepts the values
MODE_ROUTE. These values
dictates how itinerary information is written to the output. Let's suppose
we have an itinerary composed by two transit legs: first a subway leg
whose route_id is 001, and then a bus legs whose route_id is 007. If
MODE, then this itinerary will be described as
SUBWAY 001|BUS 007. Please note that the final debug information will contain
not only the itineraries that were in fact used in the itineraries
pareto_frontier(), but all the itineraries that
R5 checked when
calculating the routes. This imposes a performance penalty when tracking
debug information (but has the positive effect of returning a larger
sample of itineraries, which might help finding some implementation issues
on the fare structure).
A fare structure object.
library(r5r) data_path <- system.file("extdata/poa", package = "r5r") r5r_core <- setup_r5(data_path) #> Using cached R5 version from /home/runner/work/_temp/Library/r5r/jar/r5-v6.9-all.jar #> #> Using cached network.dat from /home/runner/work/_temp/Library/r5r/extdata/poa/network.dat fare_structure <- setup_fare_structure(r5r_core, base_fare = 5) # to debug fare calculation fare_structure <- setup_fare_structure( r5r_core, base_fare = 5, debug_path = "fare_debug.csv", debug_info = "MODE" ) fare_structure$debug_settings #> $output_file #>  "fare_debug.csv" #> #> $trip_info #>  "MODE" #> # debugging can be manually turned off by setting output_file to "" fare_structure$debug_settings <- ""