Skip to content

v1.0.0
Compare
Choose a tag to compare
@rafapereirabr rafapereirabr released this 27 Jan 17:52
· 161 commits to master since this release
v1.0.0
b102187

r5r v1.0.0

Breaking changes

  • Replaced max_walk_dist and max_bike_dist parameters with max_walk_time and max_bike_time to better align with R5 inputs. Closes #273.
  • r5r now uses R5's native elevation weighting for walking and cycling impedance functions. As a result r5r does not have raster or rgdal package dependencies anymore. Closes #243 and #233.
  • Parameters breakdown and breakdown_stat in travel_time_matrix() were removed. New function expanded_travel_time_matrix() should be used to retrieve detailed information of travel time matrices.
  • r5rnow throws an error if users simultaneously pass more than one of the following modes c('WALK','CAR','BICYCLE') to the transport_mode parameter. This is because these modes are understood as mutually exclusive.
  • Function setup_r5() no longer has a version parameter.

New functions

  • New function expanded_travel_time_matrix() to calculate minute-by-minute travel times between origin destination pairs and get additional information on public transport routes, number of transfers, and total access, waiting, in-vehicle and transfer times.
  • New function pareto_frontier() to compute of travel time and monetary cost Pareto frontier.
  • New function r5r_sitrep() to generate an r5r situation report to help debug code errors
  • New functions to account for monetary costs:
    • setup_fare_structure() to setup a fare structure to calculate the monetary costs of trips
    • read_fare_structure() to read a fare structure object from a file
    • write_fare_structure() to write a fare structure object to disk

Major changes

  • Now using R5 latest version 6.8.
  • The detailed_itineraries() has been substantially improved. The new vesion is faster than previous ones. It also includes new parameters listed below. Closes #265.
    • New time_window parameter
    • New suboptimal_minutes parameter, which extends the search space and returns a larger number of trips beyond the fastest ones;
    • Support for fare calculator and new max_fare parameter;
    • Routing in frequencies GFTS, including support for Monte Carlo draws
  • New parameter draws_per_minute to travel_time_matrix(), accessibility() and pareto_frontier() functions. Closes #230.
  • New parameter output_dir to all routing functions, which can be used to specify a directory in which the results should be saved as .csv files (one file for each origin). This parameter is particularly useful when running estimates on memory-constrained settings, because writing the results to disk prevents R5 from storing them in memory.
  • The accessibility estimates from accessibility() are now of returned as doubles / class numeric, except when using a step decay function. Closes #235.
  • The detailed_itineraries() function has a new parameter all_to_all, which allows users to set whether they want to query routes between all origins to all destinations (all_to_all = TRUE) or to query routes between the 1st origin to the 1st destination, then the 2nd origin to the 2nd destination, and so on (all_to_all = FALSE, the default). Closes #224.

Minor changes

  • Package documentation has been extensively updated and expanded.
  • Improved documentation of the cutoffs parameter in accessibility(), clarifying the function only accepts up to 12 cutoff values. Closes #216.
  • Improved documentation of the percentiles parameter in accessibility() and travel_time_matrix(), clarifying these function only accepts up to 5 values. Closes #246.
  • r5r now downloads R5 Jar directly from Conveyal's github, making the package more stable. Closes #226.
  • All functions now use verbose = FALSE and progress = FALSE by default.
  • Routing functions now require users to be non-ambiguous when specifying the modes, raising errors when it cannot disambiguate them. This new behaviour replaces the old one, in which the functions could end up trying to "guess" which mode was to be used in some edge cases.
  • Information on bicycle 'level of traffic stress' is now added to the output of street_network_to_sf(). Closes #251.
  • New columns with info on population, schools and jobs in the example data sets for Sao Paulo and Porto Alegre

Bug fixes

  • Fixed bug that transit_network_to_sf() generated some routes with invalid geometries. Closes #256.
  • Fixed bug that prevented setup_r5(path, overwrite = TRUE) to work.
Assets 2
Loading