https://github.com/riatelab/potential

An R package to compute the potential model as defined by Stewart (1941).
https://github.com/riatelab/potential

rspatial stewart

Last synced: about 1 month ago
JSON representation

An R package to compute the potential model as defined by Stewart (1941).

• Host: GitHub
• URL: https://github.com/riatelab/potential
• Owner: riatelab
• Created: 2020-09-29T14:13:19.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-13T12:21:18.000Z (almost 2 years ago)
• Last Synced: 2024-10-21T15:51:17.181Z (about 2 months ago)
• Topics: rspatial, stewart
• Language: R
• Homepage: https://riatelab.github.io/potential/
• Size: 20 MB
• Stars: 25
• Watchers: 7
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Citation: CITATION.cff

Awesome Lists containing this project

• jimsghstars - riatelab/potential - An R package to compute the potential model as defined by Stewart (1941). (R)

README

        

# potential 

[![](https://www.r-pkg.org/badges/version/potential)](https://cran.r-project.org/package=potential)

[![R-CMD-check](https://github.com/riatelab/potential/workflows/R-CMD-check/badge.svg)](https://github.com/riatelab/potential/actions)

[![codecov](https://codecov.io/gh/riatelab/potential/branch/master/graph/badge.svg?token=G8MZTHC9KQ)](https://app.codecov.io/gh/riatelab/potential)

[![Project Status: Active – The project has reached a stable, usable

state and is being actively

developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

This package provides functions to compute the potential model as

defined by Stewart (1941). Several options are available to customize

the model, for example it is possible to fine-tune the distance friction

functions or to use custom distance matrices. Some computations are

parallelized to improve their efficiency.

-   [**Website**](https://riatelab.github.io/potential/)  

-   [**Vignette**](https://riatelab.github.io/potential/articles/potential.html)  

-   [**Blog post**](https://rgeomatic.hypotheses.org/2023)

## Installation

You can install the released version of `potential` from

[CRAN](https://CRAN.R-project.org/package=potential) with:

``` r

install.packages("potential")

```

You can install the development version of `potential` from GitHub with:

``` r

# install.packages("remotes")

remotes::install_github("riatelab/potential")

```

## Demo

``` r

library(mapsf)

library(potential)

# Display the spatial interaction function

plot_inter(fun = "e", span = 75000, beta = 2, limit = 250000)

```

![](man/figures/demox-1.png)

``` r

# create a regular grid

y <- create_grid(x = n3_poly, res = 20000)

# compute potentials

pot <- mcpotential(

  x = n3_pt, y = y,

  var = "POP19",

  fun = "e", span = 75000,

  beta = 2, limit = 250000, 

  ncl = 2

)

# Define potential according to the maximum value

y$pot <- pot / max(pot) * 100

# create equipotential areas

bks <- seq(0, 100, length.out = 11)

equipot <- equipotential(y, var = "pot", breaks = bks, mask = n3_poly)

# map potentials

mf_theme("default")

mf_map(x = equipot, var = "min", type = "choro", 

       breaks = bks, 

       pal = hcl.colors(10, 'Teal'),

       border = "#121725", 

       leg_val_rnd = 0,

       lwd = .2, 

       leg_pos = "topright", 

       leg_title = "Potential Intensity")

mf_title(txt = "Potentials of Population")

mf_credits(txt = "© EuroGeographics for the administrative boundaries and © Eurostat for data")

```

![](man/figures/demo-1.png)

## Note

This package provides access to the revamped potential-related functions

initially offered by

[`SpatialPosition`](https://CRAN.R-project.org/package=SpatialPosition).

## References





Stewart, John Q. 1941. “An Inverse Distance Variation for Certain Social

Influences.” *Science* 93 (2404): 89–90.

.