TDLM (version 1.0.0)

calib_param: Automatic calibration of trip distribution laws' parameter

Description

This function returns an estimation of the optimal parameter value based on the average surface area of the locations (in square kilometer) according to the law. This estimation has only been tested on commuting data (in kilometer).

Usage

calib_param(av_surf, law = "NGravExp")

Value

An estimation of the optimal parameter value based on the average surface area of the locations.

Arguments

av_surf

a positive numeric value indicating the average surface area of the locations (in square kilometer).

law

a character indicating which law to use (see Details).

Author

Maxime Lenormand ()

Details

The estimation is based on the Figure 8 in Lenormand2016;textualTDLM for four types of laws. The normalized gravity law with an exponential distance decay function (law = "NGravExp"), the normalized gravity law with a power distance decay function (law = "NGravPow"), the Schneider's intervening opportunities law (law = "Schneider") and the extended radiation law (law = "RadExt").

References

Lenormand2016TDLM

See Also

extract_opportunities() extract_spatial_information() check_format_names()

Examples

data(county)

res <- extract_spatial_information(county, id = "ID")
av_surf <- mean(res$surface)

calib_param(av_surf = av_surf, law = "NGravExp")
calib_param(av_surf = av_surf, law = "NGravPow")
calib_param(av_surf = av_surf, law = "Schneider")
calib_param(av_surf = av_surf, law = "RadExt")