Package index • aniframe

Creating and converting aniframe objects

Functions that create an aniframe, coerce other objects to aniframe, or provide example data.

as_aniframe(): Convert a data frame to aniframe
aniframe(): aniframe package
example_aniframe(): Create example aniframe data
is_aniframe(): Check if object is an aniframe
ensure_is_aniframe(): Ensure object is an aniframe

Creating and converting anievent objects

Functions that create an anievent (long-format behavioural event records) or coerce other objects to anievent.

to_anievent(): Encode per-frame data into an anievent
as_anievent(): Cast a data frame to an anievent
anievent(): Create an anievent data frame
is_anievent(): Check if object is an anievent
ensure_is_anievent(): Ensure object is an anievent
validate_anievent(): Validate an anievent

Metadata handling

Functions for reading, setting, and retrieving the metadata attached to aniframe or anievent objects.

get_metadata(): Get metadata
set_metadata(): Set metadata
set_unit_time(): Set the temporal unit of an aniframe or anievent
set_unit_space(): Set the spatial unit of an aniframe object
set_unit_angle(): Set the angular unit of an aniframe object
set_sampling_rate(): Set the sampling rate of an aniframe or anievent
set_origin(): Set the coordinate origin
set_y_height(): Set the y-axis frame height
default_metadata(): Default metadata structure

Connections

Manage connections between identity or temporal variables (e.g. skeleton edges between keypoints, or social-network edges between individuals). Stored as a named list of from/to tibbles in metadata$connections.

set_connections() experimental: Set the connections for a variable
get_connections() experimental: Get connections from an aniframe
add_connections() experimental: Add connections to an aniframe
remove_connections() experimental: Remove connections from an aniframe

Spatial checks

These functions provide checks for your coordinate system.

is_cartesian(): Test whether a data frame uses a Cartesian coordinate system
is_cartesian_1d(): Test for a 1‑D Cartesian coordinate system
is_cartesian_2d(): Test for a 2‑D Cartesian coordinate system
is_cartesian_3d(): Test for a 3‑D Cartesian coordinate system
is_polar(): Test whether a data frame uses a polar coordinate system
is_cylindrical(): Test whether a data frame uses a cylindrical coordinate system
is_spherical(): Test whether a data frame uses a spherical coordinate system
ensure_is_cartesian(): Internal guard for Cartesian checks
ensure_is_cartesian_1d(): Internal guard for 1‑D Cartesian checks
ensure_is_cartesian_2d(): Internal guard for 2‑D Cartesian checks
ensure_is_cartesian_3d(): Internal guard for 3‑D Cartesian checks
ensure_is_polar(): Internal guard for polar checks
ensure_is_cylindrical(): Internal guard for cylindrical checks
ensure_is_spherical(): Internal guard for spherical checks

Helpers

rad_to_deg(): Convert radians to degrees
deg_to_rad(): Convert degrees to radians
convert_nan_to_na(): Convert NaN to NA in numeric columns