Names of origin and destination locations in a spatial interaction model

These functions provide low level access to origin and destination local names. It is recommended to use origin_names() and destination_names() instead of location_names and location_names<-.

Usage

location_names(sim)

location_names(sim) <- value

Arguments

sim

a spatial interaction model object

value

a list with two components (see the returned value) or NULL

Value

for location_names NULL or a list with two components: origin for the origin location names and destination for the destination location names. For location_names<-() the modified sim object.

See also

origin_names(), destination_names()

Examples

positions <- matrix(rnorm(10 * 2), ncol = 2)
rownames(positions) <- LETTERS[1:10]
distances <- as.matrix(dist(positions))
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, attractiveness)
location_names(model)
#> $origin
#>  [1] "A" "B" "C" "D" "E" "F" "G" "H" "I" "J"
#> 
#> $destination
#>  [1] "A" "B" "C" "D" "E" "F" "G" "H" "I" "J"
#> 
location_names(model) <- NULL
location_names(model) <- list(origin = letters[1:10], destination = LETTERS[1:10])
destination_names(model)
#>  [1] "A" "B" "C" "D" "E" "F" "G" "H" "I" "J"
origin_names(model)
#>  [1] "a" "b" "c" "d" "e" "f" "g" "h" "i" "j"