Package index • blvim

Creating spatial interaction models

Functions for creating spatial interaction models and extracting their parameters.

static_blvim(): Compute flows between origin and destination locations

blvim(): Compute an equilibrium solution of the Boltzmann–Lotka–Volterra model

costs(): Extract the cost matrix used to compute this model

inverse_cost(): Extract the inverse cost scale parameter used to compute this model

return_to_scale(): Extract the return to scale parameter used to compute this model

sim_is_bipartite(): Reports whether the spatial interaction model is bipartite

destination_names() `destination_names<-`(): Names of destination locations in a spatial interaction model

location_names() `location_names<-`(): Names of origin and destination locations in a spatial interaction model

origin_names() `origin_names<-`(): Names of origin locations in a spatial interaction model

destination_positions() `destination_positions<-`(): positions of destination locations in a spatial interaction model

location_positions() `location_positions<-`(): Positions of origin and destination locations in a spatial interaction model

origin_positions() `origin_positions<-`(): Positions of origin locations in a spatial interaction model

Using spatial interaction models

Functions for getting properties of spatial interaction models.

attractiveness(): Extract the attractivenesses from a spatial interaction model object

destination_flow(): Compute the flows incoming at each destination location

diversity(): Compute the diversity of the destination flows in a spatial interaction model

flows(): Extract the flow matrix from a spatial interaction model object

flows_df(): Extract the flow matrix from a spatial interaction model object in data frame format

production(): Extract the production constraints from a spatial interaction model object

sim_converged(): Reports whether the spatial interaction model construction converged

sim_iterations(): Returns the number of iterations used to produce this spatial interaction model

Non bipartite models

Functions that apply only to non bipartite models.

is_terminal(): Report whether locations are terminal sites or not

terminals(): Compute terminals for a spatial interaction model

nd_graph(): Compute the Nystuen and Dacey graph for a spatial interaction model

Multiple models

Functions to create and use multiple spatial interaction models using a grid of parameters.

grid_attractiveness(): Extract all the attractivenesses from a collection of spatial interaction models

grid_blvim(): Compute a collection of Boltzmann–Lotka–Volterra model solutions

grid_destination_flow(): Extract all the destination flows from a collection of spatial interaction models

grid_diversity(): Compute diversities for a collection of spatial interaction models

grid_is_terminal(): Extract all terminal status from a collection of spatial interaction models

grid_sim_converged(): Reports the convergence statuses of a collection of spatial interaction models

grid_sim_iterations(): Returns the number of iterations used to produce of a collection of spatial interaction models

costs(<sim_list>): Extract the common cost matrix from a collection of spatial interaction models

sim_df(): Create a spatial interaction models data frame from a collection of interaction models

sim_distance(): Compute all pairwise distances between the spatial interaction models in a collection

Graphical representations

Functions that provide graphical representations of spatial interaction models.

autoplot(<sim>): Create a complete ggplot for a spatial interaction model

autoplot(<sim_df>): Create a complete ggplot for a spatial interaction models data frame