From f7dd1ae32ca51a6d1ce3851915dfee66ccaada71 Mon Sep 17 00:00:00 2001 From: rafapereirabr Date: Thu, 23 Nov 2023 19:02:25 -0300 Subject: [PATCH] closes #353 --- r-package/NEWS.md | 2 ++ r-package/man/accessibility.Rd | 30 +++++++++++-------- r-package/man/detailed_itineraries.Rd | 30 +++++++++++-------- r-package/man/expanded_travel_time_matrix.Rd | 30 +++++++++++-------- r-package/man/pareto_frontier.Rd | 30 +++++++++++-------- r-package/man/r5r.Rd | 2 +- .../man/roxygen/templates/common_arguments.R | 30 +++++++++++-------- r-package/man/travel_time_matrix.Rd | 30 +++++++++++-------- 8 files changed, 111 insertions(+), 73 deletions(-) diff --git a/r-package/NEWS.md b/r-package/NEWS.md index 70d6bb92..03aa96ed 100644 --- a/r-package/NEWS.md +++ b/r-package/NEWS.md @@ -3,6 +3,8 @@ **Minor changes** - In the `accessibility()` function, the value of `max_trip_duration` is now capped by the max value passed to the `cutoffs` parameter. Closes [#342](https://github.com/ipeaGIT/r5r/issues/348). +- Updated documentation of parameter `max_walk_time` to make it clear that in walk-only trips, whenever `max_walk_time` differs from `max_trip_duration`, the lowest value is considered. Closes [#353](https://github.com/ipeaGIT/r5r/issues/353) +- Updated documentation of parameter `max_bike_time` to make it clear that in bicycle-only trips, whenever `max_bike_time` differs from `max_trip_duration`, the lowest value is considered. Closes [#353](https://github.com/ipeaGIT/r5r/issues/353) # r5r 1.1.0 diff --git a/r-package/man/accessibility.Rd b/r-package/man/accessibility.Rd index f9740759..9ed8e8f3 100644 --- a/r-package/man/accessibility.Rd +++ b/r-package/man/accessibility.Rd @@ -111,20 +111,26 @@ understand how this object is structured: calculating the fastest journey between each origin and destination pair.} \item{max_walk_time}{An integer. The maximum walking time (in minutes) to -access and egress the transit network, or to make transfers within the -network. Defaults to no restrictions, as long as \code{max_trip_duration} is -respected. The max time is considered separately for each leg (e.g. if -you set \code{max_walk_time} to 15, you could potentially walk up to 15 minutes -to reach transit, and up to \emph{another} 15 minutes to reach the destination -after leaving transit). Defaults to \code{Inf}, no limit.} +access and egress the transit network, to make transfers within the network +or to complete walk-only trips. Defaults to no restrictions (numeric value +of \code{Inf}), as long as \code{max_trip_duration} is respected. When routing +transit trips, the max time is considered separately for each leg (e.g. if +you set \code{max_walk_time} to 15, you could get trips with an up to 15 minutes +walk leg to reach transit and another up to 15 minutes walk leg to reach +the destination after leaving transit. In walk-only trips, whenever +\code{max_walk_time} differs from \code{max_trip_duration}, the lowest value is +considered.} \item{max_bike_time}{An integer. The maximum cycling time (in minutes) to -access and egress the transit network. Defaults to no restrictions, as long -as \code{max_trip_duration} is respected. The max time is considered separately -for each leg (e.g. if you set \code{max_bike_time} to 15 minutes, you could -potentially cycle up to 15 minutes to reach transit, and up to \emph{another} 15 -minutes to reach the destination after leaving transit). Defaults to \code{Inf}, -no limit.} +access and egress the transit network, to make transfers within the network +or to complete bicycle-only trips. Defaults to no restrictions (numeric +value of \code{Inf}), as long as \code{max_trip_duration} is respected. When routing +transit trips, the max time is considered separately for each leg (e.g. if +you set \code{max_bike_time} to 15, you could get trips with an up to 15 minutes +cycle leg to reach transit and another up to 15 minutes cycle leg to reach +the destination after leaving transit. In bicycle-only trips, whenever +\code{max_bike_time} differs from \code{max_trip_duration}, the lowest value is +considered.} \item{max_car_time}{An integer. The maximum driving time (in minutes) to access and egress the transit network. Defaults to no restrictions, as long diff --git a/r-package/man/detailed_itineraries.Rd b/r-package/man/detailed_itineraries.Rd index bbdde6be..96beca47 100644 --- a/r-package/man/detailed_itineraries.Rd +++ b/r-package/man/detailed_itineraries.Rd @@ -82,20 +82,26 @@ understand how this object is structured: calculating the fastest journey between each origin and destination pair.} \item{max_walk_time}{An integer. The maximum walking time (in minutes) to -access and egress the transit network, or to make transfers within the -network. Defaults to no restrictions, as long as \code{max_trip_duration} is -respected. The max time is considered separately for each leg (e.g. if -you set \code{max_walk_time} to 15, you could potentially walk up to 15 minutes -to reach transit, and up to \emph{another} 15 minutes to reach the destination -after leaving transit). Defaults to \code{Inf}, no limit.} +access and egress the transit network, to make transfers within the network +or to complete walk-only trips. Defaults to no restrictions (numeric value +of \code{Inf}), as long as \code{max_trip_duration} is respected. When routing +transit trips, the max time is considered separately for each leg (e.g. if +you set \code{max_walk_time} to 15, you could get trips with an up to 15 minutes +walk leg to reach transit and another up to 15 minutes walk leg to reach +the destination after leaving transit. In walk-only trips, whenever +\code{max_walk_time} differs from \code{max_trip_duration}, the lowest value is +considered.} \item{max_bike_time}{An integer. The maximum cycling time (in minutes) to -access and egress the transit network. Defaults to no restrictions, as long -as \code{max_trip_duration} is respected. The max time is considered separately -for each leg (e.g. if you set \code{max_bike_time} to 15 minutes, you could -potentially cycle up to 15 minutes to reach transit, and up to \emph{another} 15 -minutes to reach the destination after leaving transit). Defaults to \code{Inf}, -no limit.} +access and egress the transit network, to make transfers within the network +or to complete bicycle-only trips. Defaults to no restrictions (numeric +value of \code{Inf}), as long as \code{max_trip_duration} is respected. When routing +transit trips, the max time is considered separately for each leg (e.g. if +you set \code{max_bike_time} to 15, you could get trips with an up to 15 minutes +cycle leg to reach transit and another up to 15 minutes cycle leg to reach +the destination after leaving transit. In bicycle-only trips, whenever +\code{max_bike_time} differs from \code{max_trip_duration}, the lowest value is +considered.} \item{max_car_time}{An integer. The maximum driving time (in minutes) to access and egress the transit network. Defaults to no restrictions, as long diff --git a/r-package/man/expanded_travel_time_matrix.Rd b/r-package/man/expanded_travel_time_matrix.Rd index dbd4a921..39b57df6 100644 --- a/r-package/man/expanded_travel_time_matrix.Rd +++ b/r-package/man/expanded_travel_time_matrix.Rd @@ -64,20 +64,26 @@ time of each trip. Please note that setting this parameter to \code{TRUE} makes the function significantly slower.} \item{max_walk_time}{An integer. The maximum walking time (in minutes) to -access and egress the transit network, or to make transfers within the -network. Defaults to no restrictions, as long as \code{max_trip_duration} is -respected. The max time is considered separately for each leg (e.g. if -you set \code{max_walk_time} to 15, you could potentially walk up to 15 minutes -to reach transit, and up to \emph{another} 15 minutes to reach the destination -after leaving transit). Defaults to \code{Inf}, no limit.} +access and egress the transit network, to make transfers within the network +or to complete walk-only trips. Defaults to no restrictions (numeric value +of \code{Inf}), as long as \code{max_trip_duration} is respected. When routing +transit trips, the max time is considered separately for each leg (e.g. if +you set \code{max_walk_time} to 15, you could get trips with an up to 15 minutes +walk leg to reach transit and another up to 15 minutes walk leg to reach +the destination after leaving transit. In walk-only trips, whenever +\code{max_walk_time} differs from \code{max_trip_duration}, the lowest value is +considered.} \item{max_bike_time}{An integer. The maximum cycling time (in minutes) to -access and egress the transit network. Defaults to no restrictions, as long -as \code{max_trip_duration} is respected. The max time is considered separately -for each leg (e.g. if you set \code{max_bike_time} to 15 minutes, you could -potentially cycle up to 15 minutes to reach transit, and up to \emph{another} 15 -minutes to reach the destination after leaving transit). Defaults to \code{Inf}, -no limit.} +access and egress the transit network, to make transfers within the network +or to complete bicycle-only trips. Defaults to no restrictions (numeric +value of \code{Inf}), as long as \code{max_trip_duration} is respected. When routing +transit trips, the max time is considered separately for each leg (e.g. if +you set \code{max_bike_time} to 15, you could get trips with an up to 15 minutes +cycle leg to reach transit and another up to 15 minutes cycle leg to reach +the destination after leaving transit. In bicycle-only trips, whenever +\code{max_bike_time} differs from \code{max_trip_duration}, the lowest value is +considered.} \item{max_car_time}{An integer. The maximum driving time (in minutes) to access and egress the transit network. Defaults to no restrictions, as long diff --git a/r-package/man/pareto_frontier.Rd b/r-package/man/pareto_frontier.Rd index 381f1c22..784043bd 100644 --- a/r-package/man/pareto_frontier.Rd +++ b/r-package/man/pareto_frontier.Rd @@ -71,20 +71,26 @@ specified at a time. For more details, please see R5 documentation at \url{https://docs.conveyal.com/analysis/methodology#accounting-for-variability}.} \item{max_walk_time}{An integer. The maximum walking time (in minutes) to -access and egress the transit network, or to make transfers within the -network. Defaults to no restrictions, as long as \code{max_trip_duration} is -respected. The max time is considered separately for each leg (e.g. if -you set \code{max_walk_time} to 15, you could potentially walk up to 15 minutes -to reach transit, and up to \emph{another} 15 minutes to reach the destination -after leaving transit). Defaults to \code{Inf}, no limit.} +access and egress the transit network, to make transfers within the network +or to complete walk-only trips. Defaults to no restrictions (numeric value +of \code{Inf}), as long as \code{max_trip_duration} is respected. When routing +transit trips, the max time is considered separately for each leg (e.g. if +you set \code{max_walk_time} to 15, you could get trips with an up to 15 minutes +walk leg to reach transit and another up to 15 minutes walk leg to reach +the destination after leaving transit. In walk-only trips, whenever +\code{max_walk_time} differs from \code{max_trip_duration}, the lowest value is +considered.} \item{max_bike_time}{An integer. The maximum cycling time (in minutes) to -access and egress the transit network. Defaults to no restrictions, as long -as \code{max_trip_duration} is respected. The max time is considered separately -for each leg (e.g. if you set \code{max_bike_time} to 15 minutes, you could -potentially cycle up to 15 minutes to reach transit, and up to \emph{another} 15 -minutes to reach the destination after leaving transit). Defaults to \code{Inf}, -no limit.} +access and egress the transit network, to make transfers within the network +or to complete bicycle-only trips. Defaults to no restrictions (numeric +value of \code{Inf}), as long as \code{max_trip_duration} is respected. When routing +transit trips, the max time is considered separately for each leg (e.g. if +you set \code{max_bike_time} to 15, you could get trips with an up to 15 minutes +cycle leg to reach transit and another up to 15 minutes cycle leg to reach +the destination after leaving transit. In bicycle-only trips, whenever +\code{max_bike_time} differs from \code{max_trip_duration}, the lowest value is +considered.} \item{max_car_time}{An integer. The maximum driving time (in minutes) to access and egress the transit network. Defaults to no restrictions, as long diff --git a/r-package/man/r5r.Rd b/r-package/man/r5r.Rd index 72931e97..b9558377 100644 --- a/r-package/man/r5r.Rd +++ b/r-package/man/r5r.Rd @@ -44,7 +44,7 @@ Authors: \item Marcus Saraiva \email{marcus.saraiva@gmail.com} (\href{https://orcid.org/0000-0001-6218-2338}{ORCID}) \item Daniel Herszenhut \email{dhersz@gmail.com} (\href{https://orcid.org/0000-0001-8066-1105}{ORCID}) \item Carlos Kaue Vieira Braga \email{kaue@kauebraga.dev} (\href{https://orcid.org/0000-0002-6104-7297}{ORCID}) - \item Matthew Wigginton Conway \email{mwconway@asu.edu} (\href{https://orcid.org/0000-0002-1210-2982}{ORCID}) + \item Matthew Wigginton Bhagat-Conway \email{mwbc@unc.edu} (\href{https://orcid.org/0000-0002-1210-2982}{ORCID}) } Other contributors: diff --git a/r-package/man/roxygen/templates/common_arguments.R b/r-package/man/roxygen/templates/common_arguments.R index 7cf2d6aa..0bcb8d3c 100644 --- a/r-package/man/roxygen/templates/common_arguments.R +++ b/r-package/man/roxygen/templates/common_arguments.R @@ -12,19 +12,25 @@ #' for valid dates. Please see details for further information on how #' datetimes are parsed. #' @param max_walk_time An integer. The maximum walking time (in minutes) to -#' access and egress the transit network, or to make transfers within the -#' network. Defaults to no restrictions, as long as `max_trip_duration` is -#' respected. The max time is considered separately for each leg (e.g. if -#' you set `max_walk_time` to 15, you could potentially walk up to 15 minutes -#' to reach transit, and up to _another_ 15 minutes to reach the destination -#' after leaving transit). Defaults to `Inf`, no limit. +#' access and egress the transit network, to make transfers within the network +#' or to complete walk-only trips. Defaults to no restrictions (numeric value +#' of `Inf`), as long as `max_trip_duration` is respected. When routing +#' transit trips, the max time is considered separately for each leg (e.g. if +#' you set `max_walk_time` to 15, you could get trips with an up to 15 minutes +#' walk leg to reach transit and another up to 15 minutes walk leg to reach +#' the destination after leaving transit. In walk-only trips, whenever +#' `max_walk_time` differs from `max_trip_duration`, the lowest value is +#' considered. #' @param max_bike_time An integer. The maximum cycling time (in minutes) to -#' access and egress the transit network. Defaults to no restrictions, as long -#' as `max_trip_duration` is respected. The max time is considered separately -#' for each leg (e.g. if you set `max_bike_time` to 15 minutes, you could -#' potentially cycle up to 15 minutes to reach transit, and up to _another_ 15 -#' minutes to reach the destination after leaving transit). Defaults to `Inf`, -#' no limit. +#' access and egress the transit network, to make transfers within the network +#' or to complete bicycle-only trips. Defaults to no restrictions (numeric +#' value of `Inf`), as long as `max_trip_duration` is respected. When routing +#' transit trips, the max time is considered separately for each leg (e.g. if +#' you set `max_bike_time` to 15, you could get trips with an up to 15 minutes +#' cycle leg to reach transit and another up to 15 minutes cycle leg to reach +#' the destination after leaving transit. In bicycle-only trips, whenever +#' `max_bike_time` differs from `max_trip_duration`, the lowest value is +#' considered. #' @param max_car_time An integer. The maximum driving time (in minutes) to #' access and egress the transit network. Defaults to no restrictions, as long #' as `max_trip_duration` is respected. The max time is considered separately diff --git a/r-package/man/travel_time_matrix.Rd b/r-package/man/travel_time_matrix.Rd index 930c00f3..401e6aa9 100644 --- a/r-package/man/travel_time_matrix.Rd +++ b/r-package/man/travel_time_matrix.Rd @@ -80,20 +80,26 @@ understand how this object is structured: calculating the fastest journey between each origin and destination pair.} \item{max_walk_time}{An integer. The maximum walking time (in minutes) to -access and egress the transit network, or to make transfers within the -network. Defaults to no restrictions, as long as \code{max_trip_duration} is -respected. The max time is considered separately for each leg (e.g. if -you set \code{max_walk_time} to 15, you could potentially walk up to 15 minutes -to reach transit, and up to \emph{another} 15 minutes to reach the destination -after leaving transit). Defaults to \code{Inf}, no limit.} +access and egress the transit network, to make transfers within the network +or to complete walk-only trips. Defaults to no restrictions (numeric value +of \code{Inf}), as long as \code{max_trip_duration} is respected. When routing +transit trips, the max time is considered separately for each leg (e.g. if +you set \code{max_walk_time} to 15, you could get trips with an up to 15 minutes +walk leg to reach transit and another up to 15 minutes walk leg to reach +the destination after leaving transit. In walk-only trips, whenever +\code{max_walk_time} differs from \code{max_trip_duration}, the lowest value is +considered.} \item{max_bike_time}{An integer. The maximum cycling time (in minutes) to -access and egress the transit network. Defaults to no restrictions, as long -as \code{max_trip_duration} is respected. The max time is considered separately -for each leg (e.g. if you set \code{max_bike_time} to 15 minutes, you could -potentially cycle up to 15 minutes to reach transit, and up to \emph{another} 15 -minutes to reach the destination after leaving transit). Defaults to \code{Inf}, -no limit.} +access and egress the transit network, to make transfers within the network +or to complete bicycle-only trips. Defaults to no restrictions (numeric +value of \code{Inf}), as long as \code{max_trip_duration} is respected. When routing +transit trips, the max time is considered separately for each leg (e.g. if +you set \code{max_bike_time} to 15, you could get trips with an up to 15 minutes +cycle leg to reach transit and another up to 15 minutes cycle leg to reach +the destination after leaving transit. In bicycle-only trips, whenever +\code{max_bike_time} differs from \code{max_trip_duration}, the lowest value is +considered.} \item{max_car_time}{An integer. The maximum driving time (in minutes) to access and egress the transit network. Defaults to no restrictions, as long