From 8382ad4f143ab967c4f6032d85bfb945e3a40ba7 Mon Sep 17 00:00:00 2001 From: rafapereirabr Date: Sat, 5 Aug 2023 22:34:37 -0300 Subject: [PATCH] update docs --- man/floating_catchment_area.Rd | 6 +++--- man/gravity.Rd | 6 +++--- man/spatial_availability.Rd | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/man/floating_catchment_area.Rd b/man/floating_catchment_area.Rd index 429dd31..322694b 100644 --- a/man/floating_catchment_area.Rd +++ b/man/floating_catchment_area.Rd @@ -45,9 +45,9 @@ details.} impedance factor used to weight opportunities. This function should take a \code{numeric} vector and also return a \code{numeric} vector as output, with the same length as the input. For convenience, the package currently includes -the following functions: \code{\link[=decay_binary]{decay_binary()}}, \code{\link[=decay_exponential]{decay_exponential()}}, -\code{\link[=decay_exponential]{decay_exponential()}} and \code{\link[=decay_power]{decay_power()}}. See the documentation of each -decay function for more details.} +the following functions: \code{\link[=decay_binary]{decay_binary()}}, \code{\link[=decay_exponential]{decay_exponential()}} and +\code{\link[=decay_power]{decay_power()}}. See the documentation of each decay function for more +details.} \item{group_by}{A \code{character} vector. When not \code{character(0)} (the default), indicates the \code{travel_matrix} columns that should be used to group the diff --git a/man/gravity.Rd b/man/gravity.Rd index eaaa8bf..1c97381 100644 --- a/man/gravity.Rd +++ b/man/gravity.Rd @@ -36,9 +36,9 @@ with the travel cost between origins and destinations.} impedance factor used to weight opportunities. This function should take a \code{numeric} vector and also return a \code{numeric} vector as output, with the same length as the input. For convenience, the package currently includes -the following functions: \code{\link[=decay_binary]{decay_binary()}}, \code{\link[=decay_exponential]{decay_exponential()}}, -\code{\link[=decay_exponential]{decay_exponential()}} and \code{\link[=decay_power]{decay_power()}}. See the documentation of each -decay function for more details.} +the following functions: \code{\link[=decay_binary]{decay_binary()}}, \code{\link[=decay_exponential]{decay_exponential()}} and +\code{\link[=decay_power]{decay_power()}}. See the documentation of each decay function for more +details.} \item{group_by}{A \code{character} vector. When not \code{character(0)} (the default), indicates the \code{travel_matrix} columns that should be used to group the diff --git a/man/spatial_availability.Rd b/man/spatial_availability.Rd index 5c93967..dc85b21 100644 --- a/man/spatial_availability.Rd +++ b/man/spatial_availability.Rd @@ -41,9 +41,9 @@ competitors.} impedance factor used to weight opportunities. This function should take a \code{numeric} vector and also return a \code{numeric} vector as output, with the same length as the input. For convenience, the package currently includes -the following functions: \code{\link[=decay_binary]{decay_binary()}}, \code{\link[=decay_exponential]{decay_exponential()}}, -\code{\link[=decay_exponential]{decay_exponential()}} and \code{\link[=decay_power]{decay_power()}}. See the documentation of each -decay function for more details.} +the following functions: \code{\link[=decay_binary]{decay_binary()}}, \code{\link[=decay_exponential]{decay_exponential()}} and +\code{\link[=decay_power]{decay_power()}}. See the documentation of each decay function for more +details.} \item{alpha}{A \code{numeric}. A parameter used to modulate the effect of demand by population. When less than 1, opportunities are allocated more rapidly