Description Usage Arguments Value Functions Object structure See Also
View source: R/tracks_object.R
The tracks
object
1 2 3 4 |
tr |
Data.frame with tracking data (from read in functions). |
frame_rate |
Frames per second. |
resolution |
Provide standard name for resolution (e.g. "720") or actual resolution in pixels (e.g. "1920x1080"). Stored for later use, also used as default tracking window (boundary). |
meta_data |
Optionally supply a data.frame with meta data about the
trials, such as treatments. Can include a column named |
px_per_cm |
Length scaling factor. When left at 1, all measurements will be per pixel. |
minimal |
When TRUE, the minimum amount of components (see list below) are including in the object. When FALSE, the group, pairs and trial components will already be generated. |
x |
An object. |
A tracks object.
is.tracks
: Test if object is of class tracks.
The tracks object is a list
with the following tables:
tr
party_df
organized by trial, animal, frame.
Useful for storing individual variables such as location, speed,
orientation, distance to object etc.
soc
party_df
organized by trial, pair of animals,
frame. Useful for storing social variables, such as distance, relative
orientation etc.
group
tbl_df
organized by trial, frame. Useful for
storing group level variables, such as polarization, centrality, group
size, mean neighbour distance etc.
location
tbl_df
organized by trial, xbin, ybin.
Useful for aggregate data for spatial heatmaps etc.
meta_data
tbl_df
organized by trial. Contains
information about the trial, such as group origin, treatment, time of
testing etc.
animal
tbl_df
organized by trial and animal,
containing animal level measurements (nested in trial), such as average
speed.
pair
tbl_df
organized by trial and pair, containing
pair level measurements (nested in trial), such as average distance.
trial
tbl_df
organized by trial, containing trial
level measurements, such as average speed.
params
A list
with general experiment parameters, such
as frame_rate, scale, resolution etc.
tracks
, meta_data
, and params
are always present,
others may not be. This is to preserve memory space when they are not
needed. Order is not garantueed, refer by name if you need to access them.
Methods for common generics may be available.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.