activityHPDmean: Activity highest posterior density interval from mean...

In activityGCMM: Circular Mixed Effect Mixture Models of Animal Activity Patterns

Description

Estimates activity highest posterior density interval (HPD), HPD duration, number of activity peaks, peak activity times and maximum activity probability density for a given probability density mass from the GCMM activity curve predicted by the GCMM parameter posterior distribution means

Usage

activityHPDmean(
  model,
  prob = 0.5,
  scale = "2pi",
  silent = FALSE,
  plot = FALSE,
  col = "cyan4",
  ymax = "NULL"
)

Arguments

model	Object of class GCMM with output from GCMM function
prob	Value to use for probability density mass; default=0.50
scale	Scale of the data, either "2pi" for 0,2pi or "pi" for -pi,pi; default="2pi"
silent	Logical vector for whether to print output and plot; default=FALSE
plot	Logical argument for whether to plot activity curve with HPD; default=FALSE
col	Colour for HPD on plot
ymax	Value to use as upper limit of y axis on activity curve plot

Value

Returns object of class GCMMestimate with list with estimated peak activity times, maximum activity probability density, HPD interval, HPD duration, and number of activity peaks.

activityGCMM documentation built on June 15, 2021, 1:06 a.m.