join: join an mpm-estimated behavioural index to ssm-predicted...

In ianjonsen/foieGras: Fit Continuous-Time State-Space and Latent Variable Models for Quality Control of Argos Satellite (and Other) Telemetry Data and for Estimating Changes in Animal Movement

join an mpm-estimated behavioural index to ssm-predicted locations

Description

join() joins ssm-predicted locations and mpm-estimated behavioural index into a single tibble. If the ssm-predicted tibble is a projected sf object then the output of join will also be an sf object (default). This can be avoided by using as_sf = FALSE.

Usage

join(
  ssm,
  mpm,
  what.ssm = "predicted",
  as_sf = FALSE,
  normalise = FALSE,
  group = FALSE
)

Arguments

ssm	an aniMotum ssm fitted model object
mpm	an aniMotum mpm fitted model object
what.ssm	specifies whether ssm predicted or fitted values are to be extracted
as_sf	logical; if FALSE then return a tibble with un-projected lonlat coordinates, otherwise return an sf tibble
normalise	logical; if output includes a move persistence estimate, should g (the move persistence index) be normalised to have minimum = 0 and maximum = 1 (default = FALSE).
group	logical; should g be normalised among individuals as a group, a 'relative g', or separately to highlight regions of lowest and highest move persistence along a track (default = FALSE).

Value

a single tbl with all individuals

Examples

## load example aniMotum fit objects (to save time)
## generate a ssm fit object
xs <- fit_ssm(ellie, spdf=FALSE, model = "rw", time.step=24, control = ssm_control(verbose = 0))
xm <- fit_mpm(xs, what = "p", model = "mpm")

## join predicted values as an un-projected tibble
xsm <- join(xs, xm)
xsm

ianjonsen/foieGras documentation built on Jan. 17, 2025, 11:15 p.m.