Analyse and Visualise Headings and Trajectories on the Unit Disk

Documentation for package ‘radiatR’ version 0.1.3

Help Pages

-- A --

add_angle_rose	Add a rose diagram of heading angles to a radiate plot
add_circ	Draw a circular guide.
add_circular_boxplot	Add a circular boxplot layer to a radial plot
add_circular_density	Wrap a pre-computed circular density around the unit circle
add_circular_kde	Overlay a non-parametric circular kernel density estimate on a radiate plot
add_circ_interval	Render a pre-computed circular interval arc on a radial plot
add_circ_mean	Render pre-computed circular mean arrows on a radial plot
add_critical_r	Add a critical resultant-length circle to a radiate plot
add_critical_v_line	Add a V-test significance boundary to a radiate plot
add_heading_arrow	Compute a circular mean arrow and add it to a radial plot in one step
add_heading_density	Compute a circular density and add it to a radial plot in one step
add_heading_interval	Compute a circular interval arc and add it to a radial plot in one step
add_heading_points	Add heading endpoint markers on the unit circle
add_heading_vectors	Add heading vector segments from inner crossing to unit circle
add_landmark	Add a landmark marker to a circular plot
add_multiple_circles	Add multiple concentric circles to a ggplot object
add_origin_point	Mark the centre of a radial plot
add_quadrant_lines	Add quadrant lines to a radial plot
add_radial_grid	Radial grid layers (the radial analogue of a Cartesian grid)
add_stacked_headings	Add stacked heading dots as a ggplot2 layer
add_stimulus_arc	Add a stimulus arc to a circular plot
add_ticks	Create evenly spaced radial tick marks.
add_vonmises_density	Overlay a fitted von Mises density curve on a radiate plot
add_wrappedcauchy_density	Overlay a fitted wrapped Cauchy density curve on a radiate plot
angular_velocity	Per-observation angular (turning-rate) velocity for a Tracks
apply_transform	Apply a bespoke transformation to a Tracks
as.data.frame.Tracks	Coerce a Tracks to a data frame
assign_color_key	Assign a shared colour-key column to a Tracks or data frame
assign_colour_key	Assign a shared colour-key column to a Tracks or data frame
assign_cycle_colors	Assign cycling colour indices to trajectories
assign_cycle_colours	Assign cycling colour indices to trajectories
as_angle	Map periodic time, date, or numeric data onto circular angles

-- B --

bin_angles	Snap angles to fixed-width circular bin centres
boot_kappa_ci	Bootstrap confidence intervals for circular concentration
boot_kappa_contrast	Bootstrap confidence interval for a between-condition concentration contrast
boot_mean_ci	Bootstrap confidence interval for a mean direction

-- C --

c-method	Tracks container for circular trajectories
calibrate_distance	Distance calibration for a Tracks object
circular_mapping	Circular coordinate utilities
circumference_labs	Label the circumference of a radial plot in domain units
circ_boxplot_stats	Circular boxplot statistics (Tukey-like, for circular and axial data)
circ_cor	Circular correlation between headings and a covariate
circ_dispersion	Per-group circular dispersion statistics for a dense heading series
circ_display	Circular display convention specification
circ_model_select	Select among candidate circular models by AICc
circ_regression	Circular-linear regression of a heading on linear covariates
circ_summarise	Tidy circular summary of a grouped data frame
circ_summary	Circular summary statistics for trajectories
circ_summary-method	Circular summary statistics for trajectories
circ_summary_headings	Circular statistics over derived headings
compute_circular_density	Compute a circular density data frame from heading observations
compute_circ_interval	Compute a circular interval arc from heading angles
compute_circ_mean	Compute circular mean direction and resultant length from a headings data frame
concentration_regression	Von Mises regression of concentration on covariates
count_goal_entries	Count entries into a goal zone for trajectories in a circular field
cpunctatus	Cylindroiulus punctatus visual orientation trajectory dataset
cycle_colors	Cycle a bounded set of colour indices over the values of a key
cycle_colours	Cycle a bounded set of colour indices over the values of a key

-- D --

degree_labs	Label the four diagonal directions.
derive_coords	Derive polar and reference-relative coordinates from unit-circle position
derive_headings	Derive heading angle(s) from trajectories using specified rule
derive_headings-method	Derive heading angle(s) from trajectories using specified rule
directedness_arrow	Make mean resultant length arrow
distance_scale	Distance calibration for a Tracks object
distance_scale-method	Distance calibration for a Tracks object
distance_unit	Distance calibration for a Tracks object
distance_unit-method	Distance calibration for a Tracks object

-- E --

elapsed_seconds

Elapsed time per observation of a Tracks object

-- F --

fitted.circ_regression	Circular-linear regression of a heading on linear covariates
fitted.concentration_regression	Von Mises regression of concentration on covariates
fitted_directions	Fitted mean directions from a circular regression, for plotting
frame_rate	Frame rate of a Tracks object
frame_rate-method	Frame rate of a Tracks object

-- G --

get_all_object_pos	Aggregate track positions across all videos in a manifest.
get_tracked_object_pos	Derive trial-level track positions in polar coordinates.
get_trial_limits	Summarise per-trial metadata for a single video.
gg_traj	Plot trajectories from a Tracks (overlay or faceted)
gg_traj-method	Plot trajectories from a Tracks (overlay or faceted)
guess_columns	Guess the role of each column in a track table

-- H --

headings_frame	Construct a headings frame from a data frame of angles
hf_accessors	Read the canonical attributes of a heading frame
hf_color_col	Read the canonical attributes of a heading frame
hf_colour_col	Read the canonical attributes of a heading frame
hf_coords	Read the canonical attributes of a heading frame
hf_display	Read the canonical attributes of a heading frame
hf_heading_col	Read the canonical attributes of a heading frame

-- I --

ids	Trajectory identifiers of a Tracks
ids-method	Trajectory identifiers of a Tracks
import_info	Import landmark coordinates from text files
import_tracks	Discover dtrack (or compatible) landmark/track file pairs in a directory
instantaneous_speed	Per-observation instantaneous speed for a Tracks

-- L --

launch_app	Launch the radiatR Shiny companion app
length-method	Tracks container for circular trajectories
line_circle_intercept	Find the intercept of a line with the unit circle
list_heading_rules	List registered custom heading rules
list_loader_dialects	List registered loader dialects
list_loader_formats	List registered declarative formats
load_manifest	Load trajectories listed in a file table into a Tracks
log_transform	Transform history helpers for Tracks objects
log_transform-method	Transform history helpers for Tracks objects

-- P --

path_sinuosity	Sinuosity index for a single trajectory
path_straightness	Path straightness index for a single trajectory
path_tortuosity	Tortuosity ratio for a single trajectory
plot_profile	Kinematics profile plot for a Tracks
plot_speed_direction	Speed-vs-direction scatter for a Tracks
plot_speed_histogram	Speed distribution histogram for a Tracks
pose_to_headings	Derive per-frame headings from pose data without a Tracks
predict.circ_regression	Circular-linear regression of a heading on linear covariates
predict.concentration_regression	Von Mises regression of concentration on covariates
print.circ_regression	Circular-linear regression of a heading on linear covariates
print.concentration_regression	Von Mises regression of concentration on covariates

-- R --

radial_theme	Themes for radial track plots, named for the ggplot2 base themes.
radiate	Make ggplot object of tracks radiating from circle centre.
radiate.default	Make ggplot object of tracks radiating from circle centre.
radiate.headings_frame	Make ggplot object of tracks radiating from circle centre.
radiate.Tracks	Make ggplot object of tracks radiating from circle centre.
rad_shepherd	Wrap angles to the interval (-pi, pi]
read_tracks	Construct a Tracks from a data.frame or file(s)
read_tracks_dir	Read all matching files from a directory and bind into a Tracks
read_tracks_format	Construct a Tracks from a format spec (registered name or inline list)
reference	Per-trajectory reference direction of a Tracks
reference-method	Per-trajectory reference direction of a Tracks
register_heading_rule	Register a custom heading derivation rule
register_loader_dialect	Register a custom loader dialect
register_loader_format	Register a declarative loader format (list or YAML/JSON file)
restrict_to_circumference	Restrict a Tracks to within the unit circle

-- S --

scale_cardinal	Circumference scale: cardinal compass directions
scale_clock	Circumference scale: clock hours
scale_months	Circumference scale: months of the year
scale_seconds	Circumference scale: seconds (or minutes)
sector_summary	Proportion of time spent in angular sectors
set_distance_scale	Distance calibration for a Tracks object
set_distance_scale-method	Distance calibration for a Tracks object
set_frame_rate	Frame rate of a Tracks object
set_frame_rate-method	Frame rate of a Tracks object
set_reference	Set the per-trajectory reference and re-derive the relative frame
set_reference-method	Set the per-trajectory reference and re-derive the relative frame
set_transform_history	Transform history helpers for Tracks objects
set_transform_history-method	Transform history helpers for Tracks objects
simulate_tracks	Simulate trajectory sets under configurable experimental conditions
sinuosity	Per-trajectory sinuosity for a Tracks
stack_headings	Add stacking columns to a headings data frame
step_speed	Per-step speed along a trajectory
straightness_index	Per-trajectory straightness index for a Tracks
summary.circ_regression	Circular-linear regression of a heading on linear covariates
summary.concentration_regression	Von Mises regression of concentration on covariates

-- T --

test_concentration	Test whether groups share the same concentration (dispersion)
test_distributions	Test whether groups share the same circular distribution
test_gof	Goodness-of-fit test against a wrapped Cauchy distribution
test_mean_directions	Test whether groups share the same mean direction
test_symmetry	Test a circular distribution for reflective symmetry
test_uniformity	Per-group tests of circular uniformity
test_unimodality	Test a circular sample for unimodality against bimodality
tortuosity_ratio	Per-trajectory tortuosity ratio for a Tracks
tracks	Tracks container for circular trajectories
Tracks-class	Tracks container for circular trajectories
track_duration	Duration of each track
track_length	Per-trajectory path length for a Tracks
track_speed	Per-trajectory speed for a Tracks, in real units
track_turning	Per-trajectory turning-rate summary for a Tracks
track_velocity	Per-trajectory net velocity for a Tracks
transform_history	Transform history helpers for Tracks objects
transform_history-method	Transform history helpers for Tracks objects

-- V --

velocity_angle	Per-row movement direction
velocity_vector	Per-observation velocity vector for a Tracks
vonmises_fit	Fit a von Mises distribution to per-group heading data

-- W --

wrappedcauchy_fit

Fit a wrapped Cauchy distribution to per-group heading data

-- Z --

zone_dwell

Dwell-time proportions across quadrant x ring zones

-- misc --

[-method

Tracks container for circular trajectories