flume: Create a FLUvial Meta-Ecosystem model

View source: R/flume.r

flumeR Documentation

Create a FLUvial Meta-Ecosystem model

Description

Create a FLUvial Meta-Ecosystem model

Usage

flume(comm, network, sp0, st0, spb, stb, dt = 86400)

Arguments

comm

A metacommunity()

network

A river_network()

sp0

Initial site by species matrix

st0

Initial state of the model

spb

Boundary condition for species

stb

Boundary condition for resources

dt

The time step for the model, in the same time units as all fluxes

Details

sp0, st0, spb, and stb are optional parameters that define the initial states (⁠*0⁠) and boundary conditions (⁠*b⁠) for the species (⁠sp*⁠) and resources (⁠st*⁠). Initial states must be a site-by-(species or resource) matrix. Boundary conditions should be as described in river_network().

If the species and resource state variables are not defined in the network, they must be specified here. If they are specified here, they will override any state set in the network.

Boundary conditions, if not defined, will be set automatically; the boundary condition for resources will be equal to the initial state, and for species will be set to zero globally (i.e., no immigration from outside the network).

Value

An S3 object of class "flume"

Examples

data(algae)
model = flume(algae$metacommunity, algae$network, algae$sp0, algae$r0)

flee-group/flume documentation built on Jan. 29, 2024, 6:44 p.m.