# Boltzmann–Lotka–Volterra Interaction Model

## Documentation for package ‘blvim’ version 0.1.1

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

$<-.sim_df | Extract or replace parts of a SIM data frame
as.data.frame.sim_list | Coerce to a Data Frame
attractiveness | Extract the attractivenesses from a spatial interaction model object
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
autoplot.sim_list | Create a complete variability for a collection of spatial interaction models
blvim | Compute an equilibrium solution of the Boltzmann-Lotka-Volterra model
c.sim_list | Combine multiple sim_list objects into a single one
costs | Extract the cost matrix used to compute this model
costs.sim_list | Extract the common cost matrix from a collection of spatial interaction models
destination_flow | Compute the flows incoming at each destination location
destination_names | Names of destination locations in a spatial interaction model
destination_names<- | Names of destination locations in a spatial interaction model
destination_positions | positions of destination locations in a spatial interaction model
destination_positions<- | positions of destination locations in a spatial interaction model
diversity | Compute the diversity of the destination locations in a spatial interaction model
diversity.sim | Compute the diversity of the destination locations in a spatial interaction model
diversity.sim_list | Compute the diversity of the destination locations 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
fortify.sim | Turn a spatial interaction model into a data frame
fortify.sim_list | Turn a collection of spatial interaction models into a data frame
french_cities | French cities
french_cities_distances | French cities distances
french_cities_times | French cities distances
french_departments | French departments
french_regions | French regions
grid_attractiveness | Extract all the attractivenesses from a collection of spatial interaction models
grid_autoplot | Create a complete ggplot for spatial interaction models in a data frame
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
grid_var_autoplot | Create a complete variability plot for spatial interaction models in a data frame
inverse_cost | Extract the inverse cost scale parameter used to compute this model
is_terminal | Report whether locations are terminal sites or not
location_names | Names of origin and destination locations in a spatial interaction model
location_names<- | Names of origin and destination locations in a spatial interaction model
location_positions | Positions of origin and destination locations in a spatial interaction model
location_positions<- | Positions of origin and destination locations in a spatial interaction model
median.sim_list | Compute the "median" of a collection of spatial interaction models
names<-.sim_df | Set the column names of a SIM data frame
nd_graph | Compute the Nystuen and Dacey graph for a spatial interaction model
nd_graph.sim | Compute the Nystuen and Dacey graph for a spatial interaction model
origin_names | Names of origin locations in a spatial interaction model
origin_names<- | Names of origin locations in a spatial interaction model
origin_positions | Positions of origin locations in a spatial interaction model
origin_positions<- | Positions of origin locations in a spatial interaction model
print.summary_sim_list | Summary of a collection of spatial interaction models
production | Extract the production constraints from a spatial interaction model object
quantile.sim_list | Compute quantiles of the flows in a collection of spatial interaction models
return_to_scale | Extract the return to scale parameter used to compute this model
sim_column | Get the collection of spatial interaction models from a SIM data frame
sim_converged | Reports whether the spatial interaction model construction converged
sim_df | Create a spatial interaction models data frame from a collection of interaction models
sim_df_extract | Extract or replace parts of a SIM data frame
sim_distance | Compute all pairwise distances between the spatial interaction models in a collection
sim_is_bipartite | Reports whether the spatial interaction model is bipartite
sim_iterations | Returns the number of iterations used to produce this spatial interaction model
sim_list | Create a sim_list object from a list of spatial interaction objects
static_blvim | Compute flows between origin and destination locations
summary.sim_list | Summary of a collection of spatial interaction models
terminals | Compute terminals for a spatial interaction model
[.sim_df | Extract or replace parts of a SIM data frame
[<-.sim_df | Extract or replace parts of a SIM data frame
[[<-.sim_df | Extract or replace parts of a SIM data frame