FlywayNet (version 0.1.0)

new_migration: Initialize a migration structure.

Description

Initialize a migration structure.

Usage

new_migration(
  site_name,
  link_knowledge = NA,
  flight_duration,
  initial_state,
  horizon,
  death_probability,
  transition_law_type = NA,
  transition_law_param = NA,
  sojourn_law_type = NA,
  sojourn_law_param = NA,
  observation_law_type = NA,
  observation_law_param = NA,
  observation
)

Arguments

site_name

Ordered list of sites.

link_knowledge

Possible links between sites.

flight_duration

Flight duration between sites.

initial_state

Initial count of birds on each site.

horizon

Migration total duration.

death_probability

Sites death probability.

transition_law_type

Law of sites transition probability. Default value is 'multinomial'.

transition_law_param

Sites transition probability. Default value computed with link_knowledge (uniform).

sojourn_law_type

Law of site sojourn duration distribution. Default value is 'Poisson'.

sojourn_law_param

Parameters of the law of site sojourn duration distribution. Default value is 1.

observation_law_type

Law of observing birds for each site. Default value is 'Poisson'.

observation_law_param

Parameters of the law of observing birds for each site. Default value is NULL.

observation

Observed counts of birds.

Value

A migration structure.

Examples

# NOT RUN {
migr <- new_migration(
  site_name = c("s1", "s2", "s3"),
  flight_duration = matrix(c(0, 1, 2, 0, 0, 1, 0, 0, 0), ncol = 3, byrow = TRUE),
  initial_state = c(10, 0, 0),
  horizon = 5,
  death_probability = c(0.05, 0.1, 1),
  observation = matrix(c(9, 0, 0, 8, 0, 0, 2, 4, 1, 0, 0, 7), ncol = 3, byrow = TRUE)
)
# }