| verbose |
diff --git a/docs/reference/mt_plot.html b/docs/reference/mt_plot.html
index faeb7ac..40e157a 100644
--- a/docs/reference/mt_plot.html
+++ b/docs/reference/mt_plot.html
@@ -74,7 +74,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -124,15 +124,41 @@ Plot trajectory data.
for plotting velocity and acceleration profiles.
- mt_plot(data, use = "trajectories", use2 = "data", x = "xpos",
- y = "ypos", color = NULL, linetype = NULL, alpha = NA,
- size = 0.5, facet_row = NULL, facet_col = NULL, points = FALSE,
- only_ggplot = FALSE, mt_id = "mt_id", ...)
-
-mt_plot_aggregate(data, use = "trajectories", use2 = "data",
- x = "xpos", y = "ypos", color = NULL, linetype = NULL,
- alpha = NA, size = 0.5, facet_row = NULL, facet_col = NULL,
- points = FALSE, only_ggplot = FALSE, subject_id = NULL, ...)
+ mt_plot(
+ data,
+ use = "trajectories",
+ use2 = "data",
+ x = "xpos",
+ y = "ypos",
+ color = NULL,
+ linetype = NULL,
+ alpha = NA,
+ size = 0.5,
+ facet_row = NULL,
+ facet_col = NULL,
+ points = FALSE,
+ only_ggplot = FALSE,
+ mt_id = "mt_id",
+ ...
+)
+
+mt_plot_aggregate(
+ data,
+ use = "trajectories",
+ use2 = "data",
+ x = "xpos",
+ y = "ypos",
+ color = NULL,
+ linetype = NULL,
+ alpha = NA,
+ size = 0.5,
+ facet_row = NULL,
+ facet_col = NULL,
+ points = FALSE,
+ only_ggplot = FALSE,
+ subject_id = NULL,
+ ...
+)
Arguments
diff --git a/docs/reference/mt_plot_add_rect.html b/docs/reference/mt_plot_add_rect.html
index 5bc644b..cdd96ad 100644
--- a/docs/reference/mt_plot_add_rect.html
+++ b/docs/reference/mt_plot_add_rect.html
@@ -72,7 +72,7 @@
mousetrap
- 3.1.3
+ 3.1.4
diff --git a/docs/reference/mt_plot_per_trajectory.html b/docs/reference/mt_plot_per_trajectory.html
index c88b93a..961e634 100644
--- a/docs/reference/mt_plot_per_trajectory.html
+++ b/docs/reference/mt_plot_per_trajectory.html
@@ -74,7 +74,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -124,10 +124,22 @@ Create PDF with separate plots per trajectory.
acceleration profiles.
- mt_plot_per_trajectory(file, data, use = "trajectories", x = "xpos",
- y = "ypos", xlim = NULL, ylim = NULL, axes_exact = FALSE,
- points = FALSE, rect = NULL, color = "black", fill = NA,
- verbose = FALSE, ...)
+ mt_plot_per_trajectory(
+ file,
+ data,
+ use = "trajectories",
+ x = "xpos",
+ y = "ypos",
+ xlim = NULL,
+ ylim = NULL,
+ axes_exact = FALSE,
+ points = FALSE,
+ rect = NULL,
+ color = "black",
+ fill = NA,
+ verbose = FALSE,
+ ...
+)
Arguments
diff --git a/docs/reference/mt_plot_riverbed-1.png b/docs/reference/mt_plot_riverbed-1.png
index 2175a96..1dbeb63 100644
Binary files a/docs/reference/mt_plot_riverbed-1.png and b/docs/reference/mt_plot_riverbed-1.png differ
diff --git a/docs/reference/mt_plot_riverbed.html b/docs/reference/mt_plot_riverbed.html
index 9e9d24a..126567f 100644
--- a/docs/reference/mt_plot_riverbed.html
+++ b/docs/reference/mt_plot_riverbed.html
@@ -70,7 +70,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -116,9 +116,17 @@ Plot density of mouse positions across time steps.
trajectory variable (e.g., the x-positions or velocity) per time step.
- mt_plot_riverbed(data, use = "tn_trajectories", y = "xpos",
- y_range = NULL, y_bins = 250, facet_row = NULL, facet_col = NULL,
- facet_data = "data", grid_colors = c("gray30", "gray10"))
+ mt_plot_riverbed(
+ data,
+ use = "tn_trajectories",
+ y = "xpos",
+ y_range = NULL,
+ y_bins = 250,
+ facet_row = NULL,
+ facet_col = NULL,
+ facet_data = "data",
+ grid_colors = c("gray30", "gray10")
+)
Arguments
@@ -218,7 +226,7 @@ Examp
# default scale for fill with a custom scale
mt_plot_riverbed(mt_example, facet_col="Condition") +
ggplot2::scale_fill_gradientn(colours=grDevices::heat.colors(9),
- name="Frequency", trans="log", labels=scales::percent)
+ name="Frequency", trans="log", labels=scales::percent)
}
diff --git a/docs/reference/mt_qeffect.html b/docs/reference/mt_qeffect.html
index c1df028..0c12913 100644
--- a/docs/reference/mt_qeffect.html
+++ b/docs/reference/mt_qeffect.html
@@ -69,7 +69,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -114,8 +114,16 @@ Create quantile-effect plot
Function in beta and currently only for internal purposes.
- mt_qeffect(data, compare, use = "measures", measure = "MAD",
- direction = "upward", n_steps = 100, return_data = FALSE, ...)
+ mt_qeffect(
+ data,
+ compare,
+ use = "measures",
+ measure = "MAD",
+ direction = "upward",
+ n_steps = 100,
+ return_data = FALSE,
+ ...
+)
Arguments
diff --git a/docs/reference/mt_remap_symmetric.html b/docs/reference/mt_remap_symmetric.html
index 15b3518..e57545a 100644
--- a/docs/reference/mt_remap_symmetric.html
+++ b/docs/reference/mt_remap_symmetric.html
@@ -71,7 +71,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -118,9 +118,14 @@ Remap mouse trajectories.
system and a symmetric design of the response buttons (see Details).
- mt_remap_symmetric(data, use = "trajectories", save_as = use,
- dimensions = c("xpos", "ypos"), remap_xpos = "left",
- remap_ypos = "up")
+ mt_remap_symmetric(
+ data,
+ use = "trajectories",
+ save_as = use,
+ dimensions = c("xpos", "ypos"),
+ remap_xpos = "left",
+ remap_ypos = "up"
+)
Arguments
diff --git a/docs/reference/mt_resample.html b/docs/reference/mt_resample.html
index 4236446..9d3fdba 100644
--- a/docs/reference/mt_resample.html
+++ b/docs/reference/mt_resample.html
@@ -71,7 +71,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -118,10 +118,17 @@ Resample trajectories using a constant time interval.
interpolation is performed using the two adjacent timestamps.
- mt_resample(data, use = "trajectories", save_as = "rs_trajectories",
- dimensions = c("xpos", "ypos"), timestamps = "timestamps",
- step_size = 10, exact_last_timestamp = TRUE,
- constant_interpolation = NULL, verbose = FALSE)
+ mt_resample(
+ data,
+ use = "trajectories",
+ save_as = "rs_trajectories",
+ dimensions = c("xpos", "ypos"),
+ timestamps = "timestamps",
+ step_size = 10,
+ exact_last_timestamp = TRUE,
+ constant_interpolation = NULL,
+ verbose = FALSE
+)
Arguments
diff --git a/docs/reference/mt_reshape.html b/docs/reference/mt_reshape.html
index 990a265..f461469 100644
--- a/docs/reference/mt_reshape.html
+++ b/docs/reference/mt_reshape.html
@@ -73,7 +73,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -122,12 +122,23 @@ General-purpose reshape and aggregation function for mousetrap data.
are available.
- mt_reshape(data, use = "trajectories", use_variables = NULL,
- use2 = "data", use2_variables = NULL, subset = NULL,
- subject_id = NULL, aggregate = FALSE,
- aggregate_subjects_only = FALSE, .funs = "mean",
- trajectories_long = TRUE, convert_df = TRUE, mt_id = "mt_id",
- mt_seq = "mt_seq", aggregation_function = NULL)
+ mt_reshape(
+ data,
+ use = "trajectories",
+ use_variables = NULL,
+ use2 = "data",
+ use2_variables = NULL,
+ subset = NULL,
+ subject_id = NULL,
+ aggregate = FALSE,
+ aggregate_subjects_only = FALSE,
+ .funs = "mean",
+ trajectories_long = TRUE,
+ convert_df = TRUE,
+ mt_id = "mt_id",
+ mt_seq = "mt_seq",
+ aggregation_function = NULL
+)
Arguments
diff --git a/docs/reference/mt_sample_entropy.html b/docs/reference/mt_sample_entropy.html
index 83b996f..3a0ad68 100644
--- a/docs/reference/mt_sample_entropy.html
+++ b/docs/reference/mt_sample_entropy.html
@@ -70,7 +70,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -116,9 +116,16 @@ Calculate sample entropy.
of movements along one specific dimension.
- mt_sample_entropy(data, use = "tn_trajectories", save_as = "measures",
- dimension = "xpos", m = 3, r = NULL, use_diff = TRUE,
- verbose = FALSE)
+ mt_sample_entropy(
+ data,
+ use = "tn_trajectories",
+ save_as = "measures",
+ dimension = "xpos",
+ m = 3,
+ r = NULL,
+ use_diff = TRUE,
+ verbose = FALSE
+)
Arguments
diff --git a/docs/reference/mt_scale_trajectories.html b/docs/reference/mt_scale_trajectories.html
index 5657508..91e26bb 100644
--- a/docs/reference/mt_scale_trajectories.html
+++ b/docs/reference/mt_scale_trajectories.html
@@ -70,7 +70,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -116,9 +116,17 @@ Standardize variables in mouse trajectory array.
trajectory variables within or across trajectories.
- mt_scale_trajectories(data, use = "trajectories", save_as = use,
- var_names, center = TRUE, scale = TRUE, within_trajectory = FALSE,
- prefix = "z_", transform = NULL)
+ mt_scale_trajectories(
+ data,
+ use = "trajectories",
+ save_as = use,
+ var_names,
+ center = TRUE,
+ scale = TRUE,
+ within_trajectory = FALSE,
+ prefix = "z_",
+ transform = NULL
+)
Arguments
diff --git a/docs/reference/mt_space_normalize.html b/docs/reference/mt_space_normalize.html
index 7a03b06..8ff658e 100644
--- a/docs/reference/mt_space_normalize.html
+++ b/docs/reference/mt_space_normalize.html
@@ -73,7 +73,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -122,9 +122,15 @@ Space normalize trajectories.
instead, which provides the same (and additional) functionality.
- mt_space_normalize(data, use = "trajectories",
- save_as = "sn_trajectories", dimensions = c("xpos", "ypos"),
- start = c(0, 0), end = NULL, verbose = FALSE)
+ mt_space_normalize(
+ data,
+ use = "trajectories",
+ save_as = "sn_trajectories",
+ dimensions = c("xpos", "ypos"),
+ start = c(0, 0),
+ end = NULL,
+ verbose = FALSE
+)
Arguments
diff --git a/docs/reference/mt_spatialize.html b/docs/reference/mt_spatialize.html
index aba353b..6680ff8 100644
--- a/docs/reference/mt_spatialize.html
+++ b/docs/reference/mt_spatialize.html
@@ -70,7 +70,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -116,8 +116,13 @@ Spatialize trajectories.
that adjacent points on the trajectory become equidistant to each other.
- mt_spatialize(data, use = "trajectories", dimensions = c("xpos",
- "ypos"), save_as = "sp_trajectories", n_points = 20)
+ mt_spatialize(
+ data,
+ use = "trajectories",
+ dimensions = c("xpos", "ypos"),
+ save_as = "sp_trajectories",
+ n_points = 20
+)
Arguments
diff --git a/docs/reference/mt_standardize.html b/docs/reference/mt_standardize.html
index 17878ff..fb51d22 100644
--- a/docs/reference/mt_standardize.html
+++ b/docs/reference/mt_standardize.html
@@ -72,7 +72,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -120,8 +120,15 @@ Standardize mouse-tracking measures per level of other variables.
stored in a mousetrap data object.
- mt_standardize(data, use = "measures", use_variables = NULL,
- within = NULL, prefix = "z_", center = TRUE, scale = TRUE)
+ mt_standardize(
+ data,
+ use = "measures",
+ use_variables = NULL,
+ within = NULL,
+ prefix = "z_",
+ center = TRUE,
+ scale = TRUE
+)
Arguments
diff --git a/docs/reference/mt_subset.html b/docs/reference/mt_subset.html
index 4638e93..05ba464 100644
--- a/docs/reference/mt_subset.html
+++ b/docs/reference/mt_subset.html
@@ -71,7 +71,7 @@
mousetrap
- 3.1.3
+ 3.1.4
diff --git a/docs/reference/mt_time_normalize.html b/docs/reference/mt_time_normalize.html
index 3e4186e..ffb06d8 100644
--- a/docs/reference/mt_time_normalize.html
+++ b/docs/reference/mt_time_normalize.html
@@ -73,7 +73,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -122,9 +122,15 @@ Time normalize trajectories.
(following Spivey et al., 2005).
- mt_time_normalize(data, use = "trajectories",
- save_as = "tn_trajectories", dimensions = c("xpos", "ypos"),
- timestamps = "timestamps", nsteps = 101, verbose = FALSE)
+ mt_time_normalize(
+ data,
+ use = "trajectories",
+ save_as = "tn_trajectories",
+ dimensions = c("xpos", "ypos"),
+ timestamps = "timestamps",
+ nsteps = 101,
+ verbose = FALSE
+)
Arguments
diff --git a/docs/reference/print.mt_heatmap_raw.html b/docs/reference/print.mt_heatmap_raw.html
index 2cb5145..9a3f2dc 100644
--- a/docs/reference/print.mt_heatmap_raw.html
+++ b/docs/reference/print.mt_heatmap_raw.html
@@ -69,7 +69,7 @@
mousetrap
- 3.1.3
+ 3.1.4
diff --git a/docs/reference/read_mt.html b/docs/reference/read_mt.html
index 399a299..418dec0 100644
--- a/docs/reference/read_mt.html
+++ b/docs/reference/read_mt.html
@@ -78,7 +78,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -132,8 +132,7 @@ Read MouseTracker raw data.
Version 2.84 - but please be sure to double-check.
- read_mt(file, columns = "all", add_trialid = FALSE,
- add_filename = FALSE)
+ read_mt(file, columns = "all", add_trialid = FALSE, add_filename = FALSE)
Arguments
diff --git a/docs/reference/reexports.html b/docs/reference/reexports.html
index 9c6875d..0e7cce4 100644
--- a/docs/reference/reexports.html
+++ b/docs/reference/reexports.html
@@ -74,7 +74,7 @@
mousetrap
- 3.1.3
+ 3.1.4
diff --git a/docs/reference/scale_within.html b/docs/reference/scale_within.html
index aff5100..60e718c 100644
--- a/docs/reference/scale_within.html
+++ b/docs/reference/scale_within.html
@@ -73,7 +73,7 @@
mousetrap
- 3.1.3
+ 3.1.4
@@ -122,8 +122,14 @@ Scale and center variables within the levels of another variable.
measures design.
- scale_within(data, variables = NULL, within = NULL, prefix = "",
- center = TRUE, scale = TRUE)
+ scale_within(
+ data,
+ variables = NULL,
+ within = NULL,
+ prefix = "",
+ center = TRUE,
+ scale = TRUE
+)
Arguments
diff --git a/man/mousetrap.Rd b/man/mousetrap.Rd
index a783e3f..8791a93 100644
--- a/man/mousetrap.Rd
+++ b/man/mousetrap.Rd
@@ -3,7 +3,6 @@
\docType{package}
\name{mousetrap}
\alias{mousetrap}
-\alias{mousetrap-package}
\title{Process and analyze mouse-tracking data}
\description{
The mousetrap package provides functions for importing, preprocessing,
diff --git a/man/mt_add_trajectory.Rd b/man/mt_add_trajectory.Rd
index 1e1513f..8db16f7 100644
--- a/man/mt_add_trajectory.Rd
+++ b/man/mt_add_trajectory.Rd
@@ -4,8 +4,15 @@
\alias{mt_add_trajectory}
\title{Add new trajectory to trajectory array.}
\usage{
-mt_add_trajectory(data, use = "trajectories", save_as = use,
- xpos = NULL, ypos = NULL, xypos = NULL, id = "new")
+mt_add_trajectory(
+ data,
+ use = "trajectories",
+ save_as = use,
+ xpos = NULL,
+ ypos = NULL,
+ xypos = NULL,
+ id = "new"
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_aggregate.Rd b/man/mt_aggregate.Rd
index b5d88c9..1a4936a 100644
--- a/man/mt_aggregate.Rd
+++ b/man/mt_aggregate.Rd
@@ -4,9 +4,16 @@
\alias{mt_aggregate}
\title{Aggregate mouse-tracking data per condition.}
\usage{
-mt_aggregate(data, use = "measures", use_variables = NULL,
- use2 = "data", use2_variables = NULL, subject_id = NULL,
- trajectories_long = TRUE, ...)
+mt_aggregate(
+ data,
+ use = "measures",
+ use_variables = NULL,
+ use2 = "data",
+ use2_variables = NULL,
+ subject_id = NULL,
+ trajectories_long = TRUE,
+ ...
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_aggregate_per_subject.Rd b/man/mt_aggregate_per_subject.Rd
index 8ee1029..db91679 100644
--- a/man/mt_aggregate_per_subject.Rd
+++ b/man/mt_aggregate_per_subject.Rd
@@ -4,9 +4,16 @@
\alias{mt_aggregate_per_subject}
\title{Aggregate mouse-tracking data per condition separately for each subject.}
\usage{
-mt_aggregate_per_subject(data, use = "measures", use_variables = NULL,
- use2 = "data", use2_variables = NULL, subject_id,
- trajectories_long = TRUE, ...)
+mt_aggregate_per_subject(
+ data,
+ use = "measures",
+ use_variables = NULL,
+ use2 = "data",
+ use2_variables = NULL,
+ subject_id,
+ trajectories_long = TRUE,
+ ...
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_align.Rd b/man/mt_align.Rd
index 70133a7..5d4a2ff 100644
--- a/man/mt_align.Rd
+++ b/man/mt_align.Rd
@@ -4,10 +4,17 @@
\alias{mt_align}
\title{Align trajectories.}
\usage{
-mt_align(data, use = "trajectories", save_as = use,
- dimensions = c("xpos", "ypos"), coordinates = "isotropic",
- align_start = FALSE, align_end = FALSE, align_side = "no",
- verbose = FALSE)
+mt_align(
+ data,
+ use = "trajectories",
+ save_as = use,
+ dimensions = c("xpos", "ypos"),
+ coordinates = "isotropic",
+ align_start = FALSE,
+ align_end = FALSE,
+ align_side = "no",
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_align_start.Rd b/man/mt_align_start.Rd
index 1186130..5e56dfc 100644
--- a/man/mt_align_start.Rd
+++ b/man/mt_align_start.Rd
@@ -4,8 +4,14 @@
\alias{mt_align_start}
\title{Align start position of trajectories.}
\usage{
-mt_align_start(data, use = "trajectories", save_as = use,
- dimensions = c("xpos", "ypos"), start = c(0, 0), verbose = FALSE)
+mt_align_start(
+ data,
+ use = "trajectories",
+ save_as = use,
+ dimensions = c("xpos", "ypos"),
+ start = c(0, 0),
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_align_start_end.Rd b/man/mt_align_start_end.Rd
index 8ca6ced..6e639e2 100644
--- a/man/mt_align_start_end.Rd
+++ b/man/mt_align_start_end.Rd
@@ -4,9 +4,15 @@
\alias{mt_align_start_end}
\title{Align start and end position of trajectories.}
\usage{
-mt_align_start_end(data, use = "trajectories", save_as = use,
- dimensions = c("xpos", "ypos"), start = c(0, 0), end = c(-1, 1),
- verbose = FALSE)
+mt_align_start_end(
+ data,
+ use = "trajectories",
+ save_as = use,
+ dimensions = c("xpos", "ypos"),
+ start = c(0, 0),
+ end = c(-1, 1),
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_angles.Rd b/man/mt_angles.Rd
index f46e420..bf79372 100644
--- a/man/mt_angles.Rd
+++ b/man/mt_angles.Rd
@@ -4,9 +4,15 @@
\alias{mt_angles}
\title{Calculate movement angles.}
\usage{
-mt_angles(data, use = "trajectories", dimensions = c("xpos", "ypos"),
- save_as = use, na_replace = FALSE, unit = "radian",
- verbose = FALSE)
+mt_angles(
+ data,
+ use = "trajectories",
+ dimensions = c("xpos", "ypos"),
+ save_as = use,
+ na_replace = FALSE,
+ unit = "radian",
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_animate.Rd b/man/mt_animate.Rd
index bda0857..b2ff5b8 100644
--- a/man/mt_animate.Rd
+++ b/man/mt_animate.Rd
@@ -4,14 +4,33 @@
\alias{mt_animate}
\title{Create gif trajectory animation.}
\usage{
-mt_animate(data, use = "trajectories", dimensions = c("xpos", "ypos"),
- timestamps = "timestamps", filename = "trajectory_animation.gif",
- xres = 1000, seconds = 3, framerate = 24, speed = 0.5,
- density = 3, jitter = TRUE, remove = FALSE, bg = "black",
- col = "white", lwd = 1, loop = FALSE, bounds = NULL,
- norm = FALSE, upscale = 1, decay = 10, max_intensity = 5,
- discard_images = TRUE, im_path = NULL, parallel = TRUE,
- verbose = FALSE)
+mt_animate(
+ data,
+ use = "trajectories",
+ dimensions = c("xpos", "ypos"),
+ timestamps = "timestamps",
+ filename = "trajectory_animation.gif",
+ xres = 1000,
+ seconds = 3,
+ framerate = 24,
+ speed = 0.5,
+ density = 3,
+ jitter = TRUE,
+ remove = FALSE,
+ bg = "black",
+ col = "white",
+ lwd = 1,
+ loop = FALSE,
+ bounds = NULL,
+ norm = FALSE,
+ upscale = 1,
+ decay = 10,
+ max_intensity = 5,
+ discard_images = TRUE,
+ im_path = NULL,
+ parallel = TRUE,
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_average.Rd b/man/mt_average.Rd
index bb609ca..760997c 100644
--- a/man/mt_average.Rd
+++ b/man/mt_average.Rd
@@ -4,10 +4,18 @@
\alias{mt_average}
\title{Average trajectories across intervals.}
\usage{
-mt_average(data, use = "trajectories", save_as = "av_trajectories",
- dimensions = "all", av_dimension = "timestamps", intervals = NULL,
- interval_size = 100, max_interval = NULL, verbose = FALSE,
- dimension = NULL)
+mt_average(
+ data,
+ use = "trajectories",
+ save_as = "av_trajectories",
+ dimensions = "all",
+ av_dimension = "timestamps",
+ intervals = NULL,
+ interval_size = 100,
+ max_interval = NULL,
+ verbose = FALSE,
+ dimension = NULL
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_check_bimodality.Rd b/man/mt_check_bimodality.Rd
index d56b98c..d85be22 100644
--- a/man/mt_check_bimodality.Rd
+++ b/man/mt_check_bimodality.Rd
@@ -4,8 +4,15 @@
\alias{mt_check_bimodality}
\title{Assess bimodality of mouse-tracking measure distributions.}
\usage{
-mt_check_bimodality(data, use = "measures", use_variables = NULL,
- methods = c("BC", "HDS"), B = 2000, grouping_variables = NULL, ...)
+mt_check_bimodality(
+ data,
+ use = "measures",
+ use_variables = NULL,
+ methods = c("BC", "HDS"),
+ B = 2000,
+ grouping_variables = NULL,
+ ...
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_check_resolution.Rd b/man/mt_check_resolution.Rd
index 42f2f81..f7129d3 100644
--- a/man/mt_check_resolution.Rd
+++ b/man/mt_check_resolution.Rd
@@ -4,8 +4,12 @@
\alias{mt_check_resolution}
\title{Check logging resolution by looking at timestamp differences.}
\usage{
-mt_check_resolution(data, use = "trajectories",
- timestamps = "timestamps", desired = NULL)
+mt_check_resolution(
+ data,
+ use = "trajectories",
+ timestamps = "timestamps",
+ desired = NULL
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_cluster.Rd b/man/mt_cluster.Rd
index 61159dc..84ac16c 100644
--- a/man/mt_cluster.Rd
+++ b/man/mt_cluster.Rd
@@ -4,11 +4,22 @@
\alias{mt_cluster}
\title{Cluster trajectories.}
\usage{
-mt_cluster(data, use = "sp_trajectories", save_as = "clustering",
- dimensions = c("xpos", "ypos"), n_cluster = 5, method = "hclust",
- weights = rep(1, length(dimensions)), pointwise = TRUE,
- minkowski_p = 2, hclust_method = "ward.D", kmeans_nstart = 10,
- na_rm = FALSE, cluster_output = FALSE, verbose = FALSE)
+mt_cluster(
+ data,
+ use = "sp_trajectories",
+ save_as = "clustering",
+ dimensions = c("xpos", "ypos"),
+ n_cluster = 5,
+ method = "hclust",
+ weights = rep(1, length(dimensions)),
+ pointwise = TRUE,
+ minkowski_p = 2,
+ hclust_method = "ward.D",
+ kmeans_nstart = 10,
+ na_rm = FALSE,
+ cluster_output = FALSE,
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_cluster_k.Rd b/man/mt_cluster_k.Rd
index 4e57000..03b4933 100644
--- a/man/mt_cluster_k.Rd
+++ b/man/mt_cluster_k.Rd
@@ -4,12 +4,24 @@
\alias{mt_cluster_k}
\title{Estimate optimal number of clusters.}
\usage{
-mt_cluster_k(data, use = "sp_trajectories", dimensions = c("xpos",
- "ypos"), kseq = 2:15, compute = c("stability", "gap", "jump",
- "slope"), method = "hclust", weights = rep(1, length(dimensions)),
- pointwise = TRUE, minkowski_p = 2, hclust_method = "ward.D",
- kmeans_nstart = 10, n_bootstrap = 10, model_based = FALSE,
- n_gap = 10, na_rm = FALSE, verbose = FALSE)
+mt_cluster_k(
+ data,
+ use = "sp_trajectories",
+ dimensions = c("xpos", "ypos"),
+ kseq = 2:15,
+ compute = c("stability", "gap", "jump", "slope"),
+ method = "hclust",
+ weights = rep(1, length(dimensions)),
+ pointwise = TRUE,
+ minkowski_p = 2,
+ hclust_method = "ward.D",
+ kmeans_nstart = 10,
+ n_bootstrap = 10,
+ model_based = FALSE,
+ n_gap = 10,
+ na_rm = FALSE,
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_count.Rd b/man/mt_count.Rd
index 668e2bd..829d3c9 100644
--- a/man/mt_count.Rd
+++ b/man/mt_count.Rd
@@ -4,8 +4,7 @@
\alias{mt_count}
\title{Count number of observations.}
\usage{
-mt_count(data, use = "trajectories", save_as = "measures",
- dimensions = "xpos")
+mt_count(data, use = "trajectories", save_as = "measures", dimensions = "xpos")
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_derivatives.Rd b/man/mt_derivatives.Rd
index 2ed96e0..5dcb8bb 100644
--- a/man/mt_derivatives.Rd
+++ b/man/mt_derivatives.Rd
@@ -4,10 +4,17 @@
\alias{mt_derivatives}
\title{Calculate distance, velocity, and acceleration.}
\usage{
-mt_derivatives(data, use = "trajectories", save_as = use,
- dimensions = c("xpos", "ypos"), timestamps = "timestamps",
- prefix = "", absolute = FALSE, return_delta_time = FALSE,
- verbose = FALSE)
+mt_derivatives(
+ data,
+ use = "trajectories",
+ save_as = use,
+ dimensions = c("xpos", "ypos"),
+ timestamps = "timestamps",
+ prefix = "",
+ absolute = FALSE,
+ return_delta_time = FALSE,
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_deviations.Rd b/man/mt_deviations.Rd
index b79c70f..abf0ea0 100644
--- a/man/mt_deviations.Rd
+++ b/man/mt_deviations.Rd
@@ -4,9 +4,16 @@
\alias{mt_deviations}
\title{Calculate deviations from idealized trajectory.}
\usage{
-mt_deviations(data, use = "trajectories", save_as = use,
- dimensions = c("xpos", "ypos"), start_ideal = NULL,
- end_ideal = NULL, prefix = "", verbose = FALSE)
+mt_deviations(
+ data,
+ use = "trajectories",
+ save_as = use,
+ dimensions = c("xpos", "ypos"),
+ start_ideal = NULL,
+ end_ideal = NULL,
+ prefix = "",
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_diffmap.Rd b/man/mt_diffmap.Rd
index 2adb690..8ad436d 100644
--- a/man/mt_diffmap.Rd
+++ b/man/mt_diffmap.Rd
@@ -4,11 +4,24 @@
\alias{mt_diffmap}
\title{Creates a difference-heatmap of two trajectory heatmap images.}
\usage{
-mt_diffmap(x, y = NULL, condition = NULL, use = "trajectories",
- dimensions = c("xpos", "ypos"), use2 = "data", filename = NULL,
- bounds = NULL, xres = 500, upscale = 4, smooth_radius = 10,
- colors = c("#00863F", "#000000", "#FF1900"), n_shades = 1000,
- plot = TRUE, ..., verbose = TRUE)
+mt_diffmap(
+ x,
+ y = NULL,
+ condition = NULL,
+ use = "trajectories",
+ dimensions = c("xpos", "ypos"),
+ use2 = "data",
+ filename = NULL,
+ bounds = NULL,
+ xres = 500,
+ upscale = 4,
+ smooth_radius = 10,
+ colors = c("#00863F", "#000000", "#FF1900"),
+ n_shades = 1000,
+ plot = TRUE,
+ ...,
+ verbose = TRUE
+)
}
\arguments{
\item{x}{an object of class \code{mousetrap}), a trajectory object of class
diff --git a/man/mt_distmat.Rd b/man/mt_distmat.Rd
index 659ca35..0966750 100644
--- a/man/mt_distmat.Rd
+++ b/man/mt_distmat.Rd
@@ -4,9 +4,16 @@
\alias{mt_distmat}
\title{Compute distance matrix.}
\usage{
-mt_distmat(data, use = "sp_trajectories", save_as = "distmat",
- dimensions = c("xpos", "ypos"), weights = rep(1, length(dimensions)),
- pointwise = TRUE, minkowski_p = 2, na_rm = FALSE)
+mt_distmat(
+ data,
+ use = "sp_trajectories",
+ save_as = "distmat",
+ dimensions = c("xpos", "ypos"),
+ weights = rep(1, length(dimensions)),
+ pointwise = TRUE,
+ minkowski_p = 2,
+ na_rm = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_exclude_initiation.Rd b/man/mt_exclude_initiation.Rd
index c6114ab..c6558ca 100644
--- a/man/mt_exclude_initiation.Rd
+++ b/man/mt_exclude_initiation.Rd
@@ -4,9 +4,15 @@
\alias{mt_exclude_initiation}
\title{Exclude initial phase without mouse movement.}
\usage{
-mt_exclude_initiation(data, use = "trajectories", save_as = use,
- dimensions = c("xpos", "ypos"), timestamps = "timestamps",
- reset_timestamps = TRUE, verbose = FALSE)
+mt_exclude_initiation(
+ data,
+ use = "trajectories",
+ save_as = use,
+ dimensions = c("xpos", "ypos"),
+ timestamps = "timestamps",
+ reset_timestamps = TRUE,
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_export_long.Rd b/man/mt_export_long.Rd
index 612d332..15af034 100644
--- a/man/mt_export_long.Rd
+++ b/man/mt_export_long.Rd
@@ -5,11 +5,23 @@
\alias{mt_export_wide}
\title{Export mouse-tracking data.}
\usage{
-mt_export_long(data, use = "trajectories", use_variables = NULL,
- use2 = "data", use2_variables = NULL, ...)
+mt_export_long(
+ data,
+ use = "trajectories",
+ use_variables = NULL,
+ use2 = "data",
+ use2_variables = NULL,
+ ...
+)
-mt_export_wide(data, use = "trajectories", use_variables = NULL,
- use2 = "data", use2_variables = NULL, ...)
+mt_export_wide(
+ data,
+ use = "trajectories",
+ use_variables = NULL,
+ use2 = "data",
+ use2_variables = NULL,
+ ...
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_heatmap.Rd b/man/mt_heatmap.Rd
index cbd535d..014cf10 100644
--- a/man/mt_heatmap.Rd
+++ b/man/mt_heatmap.Rd
@@ -4,9 +4,16 @@
\alias{mt_heatmap}
\title{Plot trajectory heatmap.}
\usage{
-mt_heatmap(x, use = "trajectories", dimensions = c("xpos", "ypos"),
- filename = NULL, ..., upscale = 1, plot_dims = FALSE,
- verbose = TRUE)
+mt_heatmap(
+ x,
+ use = "trajectories",
+ dimensions = c("xpos", "ypos"),
+ filename = NULL,
+ ...,
+ upscale = 1,
+ plot_dims = FALSE,
+ verbose = TRUE
+)
}
\arguments{
\item{x}{usually an object of class \code{mousetrap}. Alternatively, a
diff --git a/man/mt_heatmap_ggplot.Rd b/man/mt_heatmap_ggplot.Rd
index dd949e3..74509a3 100644
--- a/man/mt_heatmap_ggplot.Rd
+++ b/man/mt_heatmap_ggplot.Rd
@@ -4,8 +4,15 @@
\alias{mt_heatmap_ggplot}
\title{Plot trajectory heatmap using ggplot.}
\usage{
-mt_heatmap_ggplot(data, use = "trajectories", dimensions = c("xpos",
- "ypos"), use2 = "data", facet_row = NULL, facet_col = NULL, ...)
+mt_heatmap_ggplot(
+ data,
+ use = "trajectories",
+ dimensions = c("xpos", "ypos"),
+ use2 = "data",
+ facet_row = NULL,
+ facet_col = NULL,
+ ...
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_heatmap_raw.Rd b/man/mt_heatmap_raw.Rd
index 7233b4e..7f63cb0 100644
--- a/man/mt_heatmap_raw.Rd
+++ b/man/mt_heatmap_raw.Rd
@@ -4,13 +4,28 @@
\alias{mt_heatmap_raw}
\title{Creates high-resolution heatmap of trajectory data.}
\usage{
-mt_heatmap_raw(data, use = "trajectories", dimensions = c("xpos",
- "ypos"), variable = NULL, bounds = NULL, xres = 1000,
- upsample = 1, norm = FALSE, colors = c("black", "blue", "white"),
- n_shades = c(1000, 1000), smooth_radius = 1.5, low_pass = 200,
- auto_enhance = TRUE, mean_image = 0.15, mean_color = 0.25,
- aggregate_lwd = 0, aggregate_col = "black", n_trajectories = NULL,
- seed = NULL, verbose = TRUE)
+mt_heatmap_raw(
+ data,
+ use = "trajectories",
+ dimensions = c("xpos", "ypos"),
+ variable = NULL,
+ bounds = NULL,
+ xres = 1000,
+ upsample = 1,
+ norm = FALSE,
+ colors = c("black", "blue", "white"),
+ n_shades = c(1000, 1000),
+ smooth_radius = 1.5,
+ low_pass = 200,
+ auto_enhance = TRUE,
+ mean_image = 0.15,
+ mean_color = 0.25,
+ aggregate_lwd = 0,
+ aggregate_col = "black",
+ n_trajectories = NULL,
+ seed = NULL,
+ verbose = TRUE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_import_long.Rd b/man/mt_import_long.Rd
index 5e7f433..8f39c0c 100644
--- a/man/mt_import_long.Rd
+++ b/man/mt_import_long.Rd
@@ -4,10 +4,18 @@
\alias{mt_import_long}
\title{Import mouse-tracking data saved in long format.}
\usage{
-mt_import_long(raw_data, xpos_label = "xpos", ypos_label = "ypos",
- zpos_label = NULL, timestamps_label = "timestamps",
- add_labels = NULL, mt_id_label = "mt_id", mt_seq_label = "mt_seq",
- reset_timestamps = TRUE, verbose = TRUE)
+mt_import_long(
+ raw_data,
+ xpos_label = "xpos",
+ ypos_label = "ypos",
+ zpos_label = NULL,
+ timestamps_label = "timestamps",
+ add_labels = NULL,
+ mt_id_label = "mt_id",
+ mt_seq_label = "mt_seq",
+ reset_timestamps = TRUE,
+ verbose = TRUE
+)
}
\arguments{
\item{raw_data}{a data.frame in long format, containing the raw data.}
diff --git a/man/mt_import_mousetrap.Rd b/man/mt_import_mousetrap.Rd
index b2438cc..0b46379 100644
--- a/man/mt_import_mousetrap.Rd
+++ b/man/mt_import_mousetrap.Rd
@@ -4,10 +4,17 @@
\alias{mt_import_mousetrap}
\title{Import mouse-tracking data recorded using the mousetrap plug-ins in OpenSesame.}
\usage{
-mt_import_mousetrap(raw_data, xpos_label = "xpos", ypos_label = "ypos",
- timestamps_label = "timestamps", mt_id_label = NULL, split = ",",
- duplicates = "remove_first", reset_timestamps = TRUE,
- verbose = FALSE)
+mt_import_mousetrap(
+ raw_data,
+ xpos_label = "xpos",
+ ypos_label = "ypos",
+ timestamps_label = "timestamps",
+ mt_id_label = NULL,
+ split = ",",
+ duplicates = "remove_first",
+ reset_timestamps = TRUE,
+ verbose = FALSE
+)
}
\arguments{
\item{raw_data}{a data.frame containing the raw data.}
diff --git a/man/mt_import_wide.Rd b/man/mt_import_wide.Rd
index 905b8b6..9869af2 100644
--- a/man/mt_import_wide.Rd
+++ b/man/mt_import_wide.Rd
@@ -4,10 +4,19 @@
\alias{mt_import_wide}
\title{Import mouse-tracking data saved in wide format.}
\usage{
-mt_import_wide(raw_data, xpos_label = "X", ypos_label = "Y",
- zpos_label = NULL, timestamps_label = "T", add_labels = NULL,
- mt_id_label = NULL, pos_sep = "_", pos_ids = NULL,
- reset_timestamps = TRUE, verbose = TRUE)
+mt_import_wide(
+ raw_data,
+ xpos_label = "X",
+ ypos_label = "Y",
+ zpos_label = NULL,
+ timestamps_label = "T",
+ add_labels = NULL,
+ mt_id_label = NULL,
+ pos_sep = "_",
+ pos_ids = NULL,
+ reset_timestamps = TRUE,
+ verbose = TRUE
+)
}
\arguments{
\item{raw_data}{a data.frame containing the raw data.}
diff --git a/man/mt_map.Rd b/man/mt_map.Rd
index e3990c5..e4a2a3d 100644
--- a/man/mt_map.Rd
+++ b/man/mt_map.Rd
@@ -4,11 +4,19 @@
\alias{mt_map}
\title{Map trajectories to prototypes.}
\usage{
-mt_map(data, use = "sp_trajectories", save_as = "prototyping",
+mt_map(
+ data,
+ use = "sp_trajectories",
+ save_as = "prototyping",
dimensions = c("xpos", "ypos"),
- prototypes = mousetrap::mt_prototypes, weights = rep(1,
- length(dimensions)), pointwise = TRUE, na_rm = FALSE,
- minkowski_p = 2, use2 = "data", grouping_variables = NULL)
+ prototypes = mousetrap::mt_prototypes,
+ weights = rep(1, length(dimensions)),
+ pointwise = TRUE,
+ na_rm = FALSE,
+ minkowski_p = 2,
+ use2 = "data",
+ grouping_variables = NULL
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_measures.Rd b/man/mt_measures.Rd
index f0e6628..48143de 100644
--- a/man/mt_measures.Rd
+++ b/man/mt_measures.Rd
@@ -4,10 +4,17 @@
\alias{mt_measures}
\title{Calculate mouse-tracking measures.}
\usage{
-mt_measures(data, use = "trajectories", save_as = "measures",
- dimensions = c("xpos", "ypos"), timestamps = "timestamps",
- flip_threshold = 0, hover_threshold = NULL,
- hover_incl_initial = TRUE, verbose = FALSE)
+mt_measures(
+ data,
+ use = "trajectories",
+ save_as = "measures",
+ dimensions = c("xpos", "ypos"),
+ timestamps = "timestamps",
+ flip_threshold = 0,
+ hover_threshold = NULL,
+ hover_incl_initial = TRUE,
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_plot.Rd b/man/mt_plot.Rd
index 6022072..1d03f0a 100644
--- a/man/mt_plot.Rd
+++ b/man/mt_plot.Rd
@@ -5,15 +5,41 @@
\alias{mt_plot_aggregate}
\title{Plot trajectory data.}
\usage{
-mt_plot(data, use = "trajectories", use2 = "data", x = "xpos",
- y = "ypos", color = NULL, linetype = NULL, alpha = NA,
- size = 0.5, facet_row = NULL, facet_col = NULL, points = FALSE,
- only_ggplot = FALSE, mt_id = "mt_id", ...)
-
-mt_plot_aggregate(data, use = "trajectories", use2 = "data",
- x = "xpos", y = "ypos", color = NULL, linetype = NULL,
- alpha = NA, size = 0.5, facet_row = NULL, facet_col = NULL,
- points = FALSE, only_ggplot = FALSE, subject_id = NULL, ...)
+mt_plot(
+ data,
+ use = "trajectories",
+ use2 = "data",
+ x = "xpos",
+ y = "ypos",
+ color = NULL,
+ linetype = NULL,
+ alpha = NA,
+ size = 0.5,
+ facet_row = NULL,
+ facet_col = NULL,
+ points = FALSE,
+ only_ggplot = FALSE,
+ mt_id = "mt_id",
+ ...
+)
+
+mt_plot_aggregate(
+ data,
+ use = "trajectories",
+ use2 = "data",
+ x = "xpos",
+ y = "ypos",
+ color = NULL,
+ linetype = NULL,
+ alpha = NA,
+ size = 0.5,
+ facet_row = NULL,
+ facet_col = NULL,
+ points = FALSE,
+ only_ggplot = FALSE,
+ subject_id = NULL,
+ ...
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_plot_per_trajectory.Rd b/man/mt_plot_per_trajectory.Rd
index 146220c..6a218eb 100644
--- a/man/mt_plot_per_trajectory.Rd
+++ b/man/mt_plot_per_trajectory.Rd
@@ -4,10 +4,22 @@
\alias{mt_plot_per_trajectory}
\title{Create PDF with separate plots per trajectory.}
\usage{
-mt_plot_per_trajectory(file, data, use = "trajectories", x = "xpos",
- y = "ypos", xlim = NULL, ylim = NULL, axes_exact = FALSE,
- points = FALSE, rect = NULL, color = "black", fill = NA,
- verbose = FALSE, ...)
+mt_plot_per_trajectory(
+ file,
+ data,
+ use = "trajectories",
+ x = "xpos",
+ y = "ypos",
+ xlim = NULL,
+ ylim = NULL,
+ axes_exact = FALSE,
+ points = FALSE,
+ rect = NULL,
+ color = "black",
+ fill = NA,
+ verbose = FALSE,
+ ...
+)
}
\arguments{
\item{file}{a character string specifying the name of the PDF file. Passed on
diff --git a/man/mt_plot_riverbed.Rd b/man/mt_plot_riverbed.Rd
index a1cbebe..a620187 100644
--- a/man/mt_plot_riverbed.Rd
+++ b/man/mt_plot_riverbed.Rd
@@ -4,9 +4,17 @@
\alias{mt_plot_riverbed}
\title{Plot density of mouse positions across time steps.}
\usage{
-mt_plot_riverbed(data, use = "tn_trajectories", y = "xpos",
- y_range = NULL, y_bins = 250, facet_row = NULL, facet_col = NULL,
- facet_data = "data", grid_colors = c("gray30", "gray10"))
+mt_plot_riverbed(
+ data,
+ use = "tn_trajectories",
+ y = "xpos",
+ y_range = NULL,
+ y_bins = 250,
+ facet_row = NULL,
+ facet_col = NULL,
+ facet_data = "data",
+ grid_colors = c("gray30", "gray10")
+)
}
\arguments{
\item{data}{mousetrap data object containing the data to be plotted.}
diff --git a/man/mt_qeffect.Rd b/man/mt_qeffect.Rd
index 19a92f2..afe3af7 100644
--- a/man/mt_qeffect.Rd
+++ b/man/mt_qeffect.Rd
@@ -4,8 +4,16 @@
\alias{mt_qeffect}
\title{Create quantile-effect plot}
\usage{
-mt_qeffect(data, compare, use = "measures", measure = "MAD",
- direction = "upward", n_steps = 100, return_data = FALSE, ...)
+mt_qeffect(
+ data,
+ compare,
+ use = "measures",
+ measure = "MAD",
+ direction = "upward",
+ n_steps = 100,
+ return_data = FALSE,
+ ...
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_remap_symmetric.Rd b/man/mt_remap_symmetric.Rd
index 4792888..2065724 100644
--- a/man/mt_remap_symmetric.Rd
+++ b/man/mt_remap_symmetric.Rd
@@ -4,9 +4,14 @@
\alias{mt_remap_symmetric}
\title{Remap mouse trajectories.}
\usage{
-mt_remap_symmetric(data, use = "trajectories", save_as = use,
- dimensions = c("xpos", "ypos"), remap_xpos = "left",
- remap_ypos = "up")
+mt_remap_symmetric(
+ data,
+ use = "trajectories",
+ save_as = use,
+ dimensions = c("xpos", "ypos"),
+ remap_xpos = "left",
+ remap_ypos = "up"
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_resample.Rd b/man/mt_resample.Rd
index f18bde1..0b06a16 100644
--- a/man/mt_resample.Rd
+++ b/man/mt_resample.Rd
@@ -4,10 +4,17 @@
\alias{mt_resample}
\title{Resample trajectories using a constant time interval.}
\usage{
-mt_resample(data, use = "trajectories", save_as = "rs_trajectories",
- dimensions = c("xpos", "ypos"), timestamps = "timestamps",
- step_size = 10, exact_last_timestamp = TRUE,
- constant_interpolation = NULL, verbose = FALSE)
+mt_resample(
+ data,
+ use = "trajectories",
+ save_as = "rs_trajectories",
+ dimensions = c("xpos", "ypos"),
+ timestamps = "timestamps",
+ step_size = 10,
+ exact_last_timestamp = TRUE,
+ constant_interpolation = NULL,
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_reshape.Rd b/man/mt_reshape.Rd
index 2643c74..c5a83e1 100644
--- a/man/mt_reshape.Rd
+++ b/man/mt_reshape.Rd
@@ -4,12 +4,23 @@
\alias{mt_reshape}
\title{General-purpose reshape and aggregation function for mousetrap data.}
\usage{
-mt_reshape(data, use = "trajectories", use_variables = NULL,
- use2 = "data", use2_variables = NULL, subset = NULL,
- subject_id = NULL, aggregate = FALSE,
- aggregate_subjects_only = FALSE, .funs = "mean",
- trajectories_long = TRUE, convert_df = TRUE, mt_id = "mt_id",
- mt_seq = "mt_seq", aggregation_function = NULL)
+mt_reshape(
+ data,
+ use = "trajectories",
+ use_variables = NULL,
+ use2 = "data",
+ use2_variables = NULL,
+ subset = NULL,
+ subject_id = NULL,
+ aggregate = FALSE,
+ aggregate_subjects_only = FALSE,
+ .funs = "mean",
+ trajectories_long = TRUE,
+ convert_df = TRUE,
+ mt_id = "mt_id",
+ mt_seq = "mt_seq",
+ aggregation_function = NULL
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_sample_entropy.Rd b/man/mt_sample_entropy.Rd
index bda0337..e5ced33 100644
--- a/man/mt_sample_entropy.Rd
+++ b/man/mt_sample_entropy.Rd
@@ -4,9 +4,16 @@
\alias{mt_sample_entropy}
\title{Calculate sample entropy.}
\usage{
-mt_sample_entropy(data, use = "tn_trajectories", save_as = "measures",
- dimension = "xpos", m = 3, r = NULL, use_diff = TRUE,
- verbose = FALSE)
+mt_sample_entropy(
+ data,
+ use = "tn_trajectories",
+ save_as = "measures",
+ dimension = "xpos",
+ m = 3,
+ r = NULL,
+ use_diff = TRUE,
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_scale_trajectories.Rd b/man/mt_scale_trajectories.Rd
index 39e4dd9..037c8dc 100644
--- a/man/mt_scale_trajectories.Rd
+++ b/man/mt_scale_trajectories.Rd
@@ -4,9 +4,17 @@
\alias{mt_scale_trajectories}
\title{Standardize variables in mouse trajectory array.}
\usage{
-mt_scale_trajectories(data, use = "trajectories", save_as = use,
- var_names, center = TRUE, scale = TRUE, within_trajectory = FALSE,
- prefix = "z_", transform = NULL)
+mt_scale_trajectories(
+ data,
+ use = "trajectories",
+ save_as = use,
+ var_names,
+ center = TRUE,
+ scale = TRUE,
+ within_trajectory = FALSE,
+ prefix = "z_",
+ transform = NULL
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_space_normalize.Rd b/man/mt_space_normalize.Rd
index bef9389..dc1f14d 100644
--- a/man/mt_space_normalize.Rd
+++ b/man/mt_space_normalize.Rd
@@ -4,9 +4,15 @@
\alias{mt_space_normalize}
\title{Space normalize trajectories.}
\usage{
-mt_space_normalize(data, use = "trajectories",
- save_as = "sn_trajectories", dimensions = c("xpos", "ypos"),
- start = c(0, 0), end = NULL, verbose = FALSE)
+mt_space_normalize(
+ data,
+ use = "trajectories",
+ save_as = "sn_trajectories",
+ dimensions = c("xpos", "ypos"),
+ start = c(0, 0),
+ end = NULL,
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_spatialize.Rd b/man/mt_spatialize.Rd
index 2de4a29..aa193d5 100644
--- a/man/mt_spatialize.Rd
+++ b/man/mt_spatialize.Rd
@@ -4,8 +4,13 @@
\alias{mt_spatialize}
\title{Spatialize trajectories.}
\usage{
-mt_spatialize(data, use = "trajectories", dimensions = c("xpos",
- "ypos"), save_as = "sp_trajectories", n_points = 20)
+mt_spatialize(
+ data,
+ use = "trajectories",
+ dimensions = c("xpos", "ypos"),
+ save_as = "sp_trajectories",
+ n_points = 20
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_standardize.Rd b/man/mt_standardize.Rd
index d82fb7d..e44d929 100644
--- a/man/mt_standardize.Rd
+++ b/man/mt_standardize.Rd
@@ -4,8 +4,15 @@
\alias{mt_standardize}
\title{Standardize mouse-tracking measures per level of other variables.}
\usage{
-mt_standardize(data, use = "measures", use_variables = NULL,
- within = NULL, prefix = "z_", center = TRUE, scale = TRUE)
+mt_standardize(
+ data,
+ use = "measures",
+ use_variables = NULL,
+ within = NULL,
+ prefix = "z_",
+ center = TRUE,
+ scale = TRUE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/mt_time_normalize.Rd b/man/mt_time_normalize.Rd
index 4068910..0a10185 100644
--- a/man/mt_time_normalize.Rd
+++ b/man/mt_time_normalize.Rd
@@ -4,9 +4,15 @@
\alias{mt_time_normalize}
\title{Time normalize trajectories.}
\usage{
-mt_time_normalize(data, use = "trajectories",
- save_as = "tn_trajectories", dimensions = c("xpos", "ypos"),
- timestamps = "timestamps", nsteps = 101, verbose = FALSE)
+mt_time_normalize(
+ data,
+ use = "trajectories",
+ save_as = "tn_trajectories",
+ dimensions = c("xpos", "ypos"),
+ timestamps = "timestamps",
+ nsteps = 101,
+ verbose = FALSE
+)
}
\arguments{
\item{data}{a mousetrap data object created using one of the mt_import
diff --git a/man/read_mt.Rd b/man/read_mt.Rd
index c87dc93..85380e9 100644
--- a/man/read_mt.Rd
+++ b/man/read_mt.Rd
@@ -4,8 +4,7 @@
\alias{read_mt}
\title{Read MouseTracker raw data.}
\usage{
-read_mt(file, columns = "all", add_trialid = FALSE,
- add_filename = FALSE)
+read_mt(file, columns = "all", add_trialid = FALSE, add_filename = FALSE)
}
\arguments{
\item{file}{a character string specifying the filename of the .mt file.}
diff --git a/man/scale_within.Rd b/man/scale_within.Rd
index 929c91a..204aa82 100644
--- a/man/scale_within.Rd
+++ b/man/scale_within.Rd
@@ -4,8 +4,14 @@
\alias{scale_within}
\title{Scale and center variables within the levels of another variable.}
\usage{
-scale_within(data, variables = NULL, within = NULL, prefix = "",
- center = TRUE, scale = TRUE)
+scale_within(
+ data,
+ variables = NULL,
+ within = NULL,
+ prefix = "",
+ center = TRUE,
+ scale = TRUE
+)
}
\arguments{
\item{data}{a \link{data.frame}.}