g.getbout: function to calculate bouts from vector of binary classes

View source: R/g.getbout.R

g.getboutR Documentation

function to calculate bouts from vector of binary classes

Description

To detect bouts of behaviour in time series. The function is used by g.analyse

Usage

  g.getbout(x, boutduration, boutcriter = 0.8, ws3 = 5)

Arguments

x

vector of zeros and/or ones to be screened for bouts of ones

boutduration

duration of bout in epochs

boutcriter

Minimum percentage of boutduration for which the epoch values are expected to meet the threshold criterium

ws3

epoch length in seconds, only needed for bout.metric =3, because it needs to measure how many epochs equal 1 minute breaks

Value

Vector with binary numbers indicator where bouts where detected

Author(s)

Vincent T van Hees <v.vanhees@accelting.com> Jairo Hidalgo Migueles

Examples

  y = g.getbout(x=round(runif(1000, 0.4, 1)), boutduration = 120, boutcriter=0.9,
    ws3 = 5)

GGIR documentation built on Oct. 17, 2023, 1:12 a.m.