Unlimited learning, half price | 50% off

Last chance! 50% off unlimited learning

Sale ends in


Rtrack (version 1.0.7)

calculate_metrics: Calculation of spatial search path metrics.

Description

Calculates a range of metrics from path coordinates.

Usage

calculate_metrics(path, arena)

Value

An rtrack_metrics object containing metrics of the search path. This object is required as input for the call_strategy and

plot_path functions.

Arguments

path

An rtrack_path object as returned by read_path.

arena

An rtrack_arena object as returned by read_arena.

Details

Metrics are calculated based on normalised coordinate data and are available as the summary element of the rtrack_path object. Unnormalised values (with the same units as the raw data) are also available as the unscaled.summary element. These can be useful for custom plots and are also the values exported by export_results. Extended metrics are available as separate elements of the rtrack_path object.

See Also

read_path, read_arena, and also read_experiment for processing many tracks at once.

Examples

Run this code
require(Rtrack)
track_file <- system.file("extdata", "Track_1.csv", package = "Rtrack")
arena_description <- system.file("extdata", "Arena_SW.txt", package = "Rtrack")
arena <- read_arena(arena_description)
path <- read_path(track_file, arena, track.format = "ethovision.3.csv")
metrics <- calculate_metrics(path, arena)

Run the code above in your browser using DataLab