mas: Multiscalar Absolute Synthesis

Description Usage Arguments Value Examples

View source: R/mas.R

Description

This function sums the total amount of redistributions according to the three absolute deviations (global, territorial, spatial).

Usage

1
2
mas(x, var1, var2, ref = NULL, key, spdf, order = NULL, dist = NULL,
  mat = NULL, spdfid = NULL, xid = NULL)

Arguments

x

a data frame.

var1

name of the numerator variable in x.

var2

name of the denominator variable in x.

ref

ratio of reference; if NULL, the ratio of reference is the one of the whole study area (sum(var1) / sum(var2)).

key

aggregation key field.

spdf

a SpatialPolygonsDataFrame that matches x data frame.

order

contiguity order.

dist

distance threshold defining the contiguity. The cartesian distance between units centroids is used by default (see gDistance); use mat to apply different metrics.

mat

a distance matrix (road distance, travel time...) between x units. Row and column names must fit xid identifiers. (optional)

spdfid

identifier field in spdf, default to the first column of the spdf data frame. (optional)

xid

identifier field in x, default to the first column of x. (optional)

Value

A dataframe including the mass of numerator to redistribue to reach a perfect equilibrium according to the 3 contexts, expressed in numerator measure unit and as a share of the numerator mass.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
data("GrandParisMetropole")
redistr <- mas(spdf = com.spdf,
                       x = com,
                       spdfid = "DEPCOM",
                       xid = "DEPCOM",
                       var1 = "INC",
                       var2 = "TH",
                       order = 2,
                       key = "EPT",
                       dist = NULL,
                       mat = NULL)
redistr

MTA documentation built on Sept. 25, 2017, 5:03 p.m.