Community Point Pattern Class

Community Point Pattern Class

Community Point Pattern Class

Details

A community_model whose pattern is a dbmss::wmppp object..

Super class

SimComm::community_model -> community_spcmodel

Public fields

tess

The Dirichlet tessellation of the spatial point pattern.

Methods

Public methods

• community_spcmodel$new()

• community_spcmodel$neighbors_n()

• community_spcmodel$neighbors_r()

• community_spcmodel$neighbor_types_r()

• community_spcmodel$plot()

• community_spcmodel$clone()

Inherited methods

• SimComm::community_model$along_time()
• SimComm::community_model$autoplot()
• SimComm::community_model$run()
• SimComm::community_model$saved_pattern()

---

Method new()

Create a new instance of this R6 class.

Usage

community_spcmodel$new(
  pattern = SpatDiv::rSpCommunity(n = 1, size = 100, CheckArguments = FALSE),
  timeline = 0,
  type = "Species"
)

Arguments

pattern

The pattern which describes the location of agents.

timeline

A numeric vector that contains the points of time of interest.

type

The type of individuals. Informational only.

---

Method neighbors_n()

The n nearest neighbors

Usage

community_spcmodel$neighbors_n(n)

Arguments

n

The number of neighbors considered as in the neighborhood.

---

Method neighbors_r()

Neighbors less than r apart

Usage

community_spcmodel$neighbors_r(r, keep_distances = FALSE)

Arguments

r

The distance that defines the neighborhood.

keep_distances

if TRUE, save the vector of distances to neighbors in the attribute the_neighbors.

---

Method neighbor_types_r()

The type of neighbors less than r apart

Usage

community_spcmodel$neighbor_types_r(r)

Arguments

r

The distance that defines the neighborhood.

---

Method plot()

Plots the pattern.

Usage

community_spcmodel$plot(time = NULL, sleep = 0, which.marks = "PointType", ...)

Arguments

time

The point of the timeline considered.

sleep

The time (in ms) to sleep between each step of the evolution of the model.

which.marks

The marks to plot, that must be a the name of a column of the mark dataframe.

...

Extra arguments to be passed to methods.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

community_spcmodel$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.