StatReserveList: StatReserveList

StatReserveListR Documentation

StatReserveList

Description

This function computes several statistics on the reserve.list (see function findCluster).

Usage

StatReserveList(reserve.list, dat)

Arguments

reserve.list

list containing the information on the reserve list. It is the output of the findClusters function. Each component of the list should contain (at least): the type of assignment to the reserve list, the iteration number, the cluster dissolved to be assigned to the reserve list and its validity, the community assigned to the reserve list. See function findClusters.

dat

data.frame/data.table containing the commuting data. Each row corresponds to an observation, i.e. a flow, and each column corresponds to a variable. The variables are named: community_live: (integer) contains the id number of the elementary zone of residence, community_work: (integer) contains the id number of the working community (elementary zone of work), amount: (numeric) contains the number of employees commuting between the "community_live" and "community_work" (direction is important). Missing values (NAs) are not allowed. The community id must be strictly positive. Negative flows are not allowed.

Value

A list with the following components:

NumComm

integer; number of communities in the reserve list

NumClus

integer; as each community in the reserve list initially belonged to a cluster, this statistics reports the number of different clusters in the reserve list. The clusters ID are the ones initially generated by the algorithm.

NumUniqueClus

integer; number of clusters (for communities in the reserve list) with a unique community.

summaryCommByClus

numeric vector; summary statistics on the number of communities, by cluster. Only the communities included in the reserve list are considered.

summaryValidities

numeric vector; summary statistics on validity values of the clusters when they were considered for the reserve.list.

TypesTable

frequency table of the types of assignment of the communities to the reserve list.

Residents

data.table of two columns: communities in the reserve list and their residents.

summaryResidByComm

numeric vector; summary statistics on the number of residents by community in the reserve list.

Workers

data.table of two columns: communities in the reserve list and their jobs.

summaryWorkersByCom

numeric vector; summary statistics on the number of workers by community in the reserve list.

Author(s)

Daniela Ichim, Luisa Franconi

References

[1] Franconi, L., D'Alo' M. and Ichim, D. (2016). Istat implementation of the algorithm to develop Labour Market Areas.

See Also

findClusters


LabourMarketAreas documentation built on Oct. 10, 2023, 5:07 p.m.