Skip to contents

Names of origin locations in a spatial interaction model

Source: R/sim_names.R
origin_names.Rd

Functions to get or set the names of the origin locations in a spatial interaction model (or in a collection of spatial interaction models).

Usage

origin_names(sim)

origin_names(sim) <- value

Arguments

sim

a spatial interaction model object (an object of class sim) or a collection of spatial interaction models (an object of class sim_list)

value

a character vector of length equal to the number of origin locations, or NULL (vectors of adapted length are converted to character vectors)

Value

for origin_names NULL or a character vector with one name per origin locations in the model. for origin_names<- the modified sim object or sim_list object.

See also

location_names(), destination_names()

Examples

distances <- french_cities_distances[1:10, 1:10]
production <- rep(1, 10)
attractiveness <- rep(1, 10)
## the row/column names of the cost matrix are used for the location
model <- static_blvim(distances, production, 1.5, 1 / 250000, attractiveness)
origin_names(model)
#>  [1] "75056" "13055" "69123" "31555" "06088" "44109" "34172" "67482" "33063"
#> [10] "59350"
origin_names(model) <- french_cities$name[1:10]
origin_names(model)
#>  [1] "Paris"       "Marseille"   "Lyon"        "Toulouse"    "Nice"       
#>  [6] "Nantes"      "Montpellier" "Strasbourg"  "Bordeaux"    "Lille"