RSEEsmooth: RSEEsmooth - performs LOWESS and RRM

In tfrostig/RSEE: RSEE - R Software for the Exploration of Exploration

Description

RSEEsmooth - performs LOWESS and RRM

Usage

RSEEsmooth(object = NULL, path = NULL, project = "",
  individual = "", forced = T, fps = 25, h.loess = 10,
  d.loess = 2, r.loess = 2, frames.rrm = 5, cutoff.rrm = 1e-06,
  h.rrm = c(7, 5, 3, 3))

Arguments

object	data frame with x and y coordinates. name of x coordinates vector should contain "x" or "X" column name of y coordinates vector should contain "y" or "Y"
path	if object is NULL, loads a CSV file of XY coordinates
project	project name
individual	name of individual animal
forced	set to TRUE if no fixed homebase, and FALSE if fixed homebase (free exploration)
fps	frames per second (of the tracked video)
h.loess	half window width of LOWESS
d.loess	degree of polynomial (only d=2 implemented for velocities and accelerations)
r.loess	number of LOWESS iterations (recommended: 2)
frames.rrm	RRM arguments (see NOTE)
cutoff.rrm	RRM arguments (see NOTE)
h.rrm	sequence of half-window widths for repeated RM

Value

The function returns a list with following objects:

smooth.data

data frame, containing for each frame: smooth x and y coordinates, smooth velocities and accelerations in x and y, and entry.

speed.acc

data frame of smooth point speeds and accelerations

entry

data frame of start and end frames for each entry (only 1 entry if forced = T)

motion.segments

data frame of start and end frames for each arrest

info - list of general information about the session:

project, individual

input names

session.length.minutes

length of the session in minutes

home

fixed homebase coordinates (if forced = F)

number.of.entries

more than 1 if forced = F

Note

an arrest is a sequence of at least "frames.rrm" frames in which the maximum distance between the two farthest points (after RRM) is no more than "cutoff.rrm"

tfrostig/RSEE documentation built on Feb. 5, 2020, 5:42 p.m.