rubitLoadFile: Reads raw data from a UbiTrail result file.

In JoGall/rubitrail: rubitrail, a package to analyse the output of UbiTrail, an open-source video tracking program for analysis of animal locomotion.

Description

A general function to read raw tracking data and meta information from a .csv result file outputted by UbiTrail.

Usage

rubitLoadFile(FILE, verbose = FALSE)

Arguments

FILE	a CSV result file outputted by UbiTrail.
verbose	logical; if TRUE, the function will print messages at every step.

Value

A list of numerical matrices with each matrix corresponding to an area.

Note

The returned list contains a numerical matrix for each area. The attributes of list contain metadata and additional information is present in each of the attributes of each matrix.

See Also

rubitBasic and rubitMetrics for more further processing and analysis of tracking data.

Examples

## Locate raw data example including with package
FILE <- system.file("extdata", "tenebrio_ubitrail.csv.gz", package = "rubitrail")

tenebrio_raw <- rubitLoadFile(FILE)

###See general metadata:
attributes(tenebrio_raw)

###See how many reads in each area:
summary(tenebrio_raw)

###See informations about the area named '08':
attributes(tenebrio_raw[['08']])

JoGall/rubitrail documentation built on May 7, 2019, 10:53 a.m.