Fix typos in documentation

R/add.R

@@ -80,7 +80,7 @@ mt_add_trajectory <- function(
 #' Join two trajectory arrays
 #' 
 #' Join two trajectory arrays. This function is mainly used internally, but can 
-#' be helpful in those (relatively rare) occasions where addional processed 
+#' be helpful in those (relatively rare) occasions where additional processed 
 #' trajectory data should be added to another trajectory array.
 #' 
 #' @inheritParams mt_time_normalize

R/align.R

@@ -44,7 +44,7 @@
 #'   or not at all (\code{no}). Assumes that first entry in \code{dimensions}
 #'   are the x positions.
 #' @return A mousetrap data object (see \link{mt_example}) with aligned 
-#'   trajectories. Per default, the dimemnsions in the original trajectory array
+#'   trajectories. Per default, the dimensions in the original trajectory array
 #'   will be replaced. If a different trajectory array is specified using
 #'   \code{save_as}, a new trajectory array will be created (including only the
 #'   aligned dimensions). If a trajectory array was provided directly as

R/animate.R

@@ -24,7 +24,7 @@
 #' By default, \code{mt_animate} animates trajectories using the original 
 #' timestamps. Timestamps are expected to be expressed in milliseconds. By
 #' setting \code{timestamps = NULL}, the function can also assume timestamps to
-#' be regualar, i.e., of constant interval, in this case the longest duration is
+#' be regular, i.e., of constant interval, in this case the longest duration is
 #' set to exactly one second.
 #' 
 #' In order to create high-resolution (large) animations in a relatively short
@@ -55,7 +55,7 @@
 #'   their original velocity profile. I.e., a value of .5 shows trajectories in 
 #'   half of the original velocities, whereas a value of 2 shows trajectories in
 #'   double of the original velocities.
-#' @param density integer specifiying the number of trajectories to be added 
+#' @param density integer specifying the number of trajectories to be added 
 #'   each frame. I.e., if \code{density = 10}, \code{seconds = 10}, 
 #'   \code{framerate = 24} and \code{speed = .5} then the animation will show 10
 #'   x 10 x 24 x .5 = 1200 trajectories.
@@ -66,7 +66,7 @@
 #'   points should be removed from the rest of the animation. Defaults to 
 #'   \code{FALSE} implying that all finished trajectories remain visible.
 #' @param bg character string specifying the background color.
-#' @param col character string specifiyng the foreground color, i.e., the color 
+#' @param col character string specifying the foreground color, i.e., the color 
 #'   used to draw the trajectories.
 #' @param lwd numeric specifying the line width of the trajectories.
 #' @param loop logical specifying whether gif should be looped. If \code{FALSE}
@@ -76,7 +76,7 @@
 #'   limits of the animation canvas. Defaults to \code{NULL} in which case the 
 #'   animation canvas is set to include all existing trajectory points,
 #'   irrespective of how extreme they may be.
-#' @param norm logical specifying wether the trajectories should be remapped to
+#' @param norm logical specifying whether the trajectories should be remapped to
 #'   the \emph{mt-space}. See \link{mt_align}. Note that aligning often requires
 #'   that that all trajectories are flipped to one side first (see
 #'   \link{mt_remap_symmetric}).

R/bezier.R

@@ -1,7 +1,7 @@
 #' Create Bezier-curves using the Bernstein approximation.
 #' 
 #' \code{bezier} creates 3-point Bezier-curves using the 
-#'   Bernstein appproximation to simulate continuous competition 
+#'   Bernstein approximation to simulate continuous competition 
 #'   in mouse- and hand-trajectories.   
 #'   
 #' @param x a numeric vector giving the x-coordinates of exactly three

R/cluster.R

@@ -2,7 +2,7 @@
 #' 
 #' Performs trajectory clustering. It first computes distances between each pair
 #' of trajectories and then applies off-the-shelf clustering tools to explain 
-#' the resulting dissimiliarity matrix using a predefined number of clusters.
+#' the resulting dissimilarity matrix using a predefined number of clusters.
 #' 
 #' \code{mt_cluster} uses off-the-shelf clustering tools, i.e., 
 #' \link[fastcluster]{hclust} and \link[stats]{kmeans}, for cluster estimation. 
@@ -42,7 +42,7 @@
 #'   should be used. Can be of length 2 or 3, for two-dimensional or 
 #'   three-dimensional trajectories respectively.
 #' @param n_cluster an integer specifying the number of clusters to estimate.
-#' @param method character string specifiying the clustering procedure. Either
+#' @param method character string specifying the clustering procedure. Either
 #'   \link[fastcluster]{hclust} (the default) or \link[stats]{kmeans}.
 #' @param weights numeric vector specifying the relative importance of the 
 #'   variables specified in \code{dimensions}. Defaults to a vector of 1s 

R/cluster_k.R

@@ -30,7 +30,7 @@
 #'   the metrics specified in \code{compute}.
 #' @param compute character vector specifying the to be computed measures. Can
 #'   be any subset of \code{c("stability","gap","jump","slope")}.
-#' @param method character string specifiying the type of clustering procedure
+#' @param method character string specifying the type of clustering procedure
 #'   for the stability-based method. Either \code{hclust} or \code{kmeans}.
 #' @param n_bootstrap an integer specifying the number of bootstrap comparisons
 #'   used by \code{stability}. See \link[cstab]{cStability}.

R/derivatives.R

@@ -33,7 +33,7 @@
 #' @param dimensions a character vector specifying across which dimension(s)
 #'   distances, velocity, and acceleration are calculated. By default
 #'   (\code{c("xpos","ypos")}), they are calculated across both x and y
-#'   dimensions. Alternatively, only one dimesion can be specified, e.g.,
+#'   dimensions. Alternatively, only one dimension can be specified, e.g.,
 #'   \code{"xpos"} or \code{"ypos"}.
 #' @param timestamps a character string specifying the trajectory dimension
 #'   containing the timestamps.

R/deviations.R

@@ -11,7 +11,7 @@
 #' If a deviation occurs above the direct path, this is denoted by a positive 
 #' value. If it occurs below the direct path, this is denoted by a negative 
 #' value. This assumes that the complete movement in the trial was from bottom 
-#' to top (i.e., the end point has a higher y-position than the start poins). In
+#' to top (i.e., the end point has a higher y-position than the start points). In
 #' case the movement was from top to bottom, \code{mt_deviations} 
 #' automatically flips the signs. Note that the second dimension specified in 
 #' \code{dimensions} is used for determining all this.

R/distmat.R

@@ -8,7 +8,7 @@
 #' distance metric defined by \code{minkowski_p} for every point of the 
 #' trajectory and then summing the results. That is, if \code{minkowski_p = 2} 
 #' the point-wise dissimilarity between two trajectories, each defined by a set 
-#' of x and y cooridnates, is calculated as \code{sum(sqrt(x^2 + y^2))}. 
+#' of x and y coordinates, is calculated as \code{sum(sqrt(x^2 + y^2))}. 
 #' Vector-wise dissimilarity, on the other hand refers to computing the distance
 #' metric once for the entire trajectory. That is, vector-wise dissimilarity is 
 #' computed as \code{sqrt(sum(x^2 + y^2))}.

R/heatmap.R

@@ -18,7 +18,7 @@
 #' colors specified in \code{colors}. Finally, the function returns the image 
 #' data in a long format containing the x, y, and color information.
 #' 
-#' \code{mt_heatmap_raw} also offers the possibilty to overlay the heatmap with 
+#' \code{mt_heatmap_raw} also offers the possibility to overlay the heatmap with 
 #' an additional variable, such as for instance velocity, so that both the 
 #' density of mouse trajectories and the information of the additional variable 
 #' are visible. In order to do this, specify a third variable label in 

R/measures.R

@@ -56,7 +56,7 @@
 #' subtracting the value of the first timestamp from all timestamps within a
 #' trial (assuming that the first timestamp corresponds to the time when
 #' tracking started). Timestamps are reset by default when importing the data
-#' using one of the mt_import fuctions (e.g., \link{mt_import_mousetrap}).
+#' using one of the mt_import functions (e.g., \link{mt_import_mousetrap}).
 #' 
 #' 
 #' 

R/preprocess.R

@@ -1095,7 +1095,7 @@ mt_subset <- function(data, subset, check="data") {
 #' @return A mousetrap data object (see \link{mt_example}).
 #'   
 #'   If a data.frame with label specified in \code{save_as} (by default 
-#'   "measures") already exists, the number of obervations (called \code{nobs})
+#'   "measures") already exists, the number of observations (called \code{nobs})
 #'   are added as additional column. If not, an additional \link{data.frame}
 #'   will be added.
 #'   

R/read_mt.R

@@ -30,7 +30,7 @@
 #' @seealso
 #' 
 #' \link[readbulk]{read_bulk} from the \code{readbulk} package for reading and 
-#' combining mutliple raw data files.
+#' combining multiple raw data files.
 #' 
 #' \link{mt_import_wide} to prepare the imported data for analyses in mousetrap.
 #' 

R/standardize.R

@@ -207,7 +207,7 @@ mt_standardize <-function(data, use="measures",
 #'   \code{scale} are mapped to the variables specified in \code{var_names}.
 #' @param scale logical or numeric specifying the scaling of the variables. When
 #'   logical, \code{scale = TRUE} normalizes the trajectory variable to sd = 1,
-#'   wheras \code{scale = FALSE} leaves the variable on its original scale. When
+#'   whereas \code{scale = FALSE} leaves the variable on its original scale. When
 #'   numeric, the trajectory variables are scaled by (i.e., divided by) the
 #'   specific value in scale. Can also be a numeric vector, in which case the
 #'   values of \code{scale} are mapped to the variables specified in