Update function references & online documentation

PascalKieslich · Jan 3, 2022 · b861f90 · b861f90
1 parent 18a92f9
commit b861f90
Show file tree

Hide file tree

Showing 15 changed files with 104 additions and 57 deletions.
diff --git a/R/cluster.R b/R/cluster.R
@@ -10,7 +10,7 @@
 #' computed by \link{mt_distmat}.
 #' 
 #' Mouse trajectories often occur in distinct, qualitative types (see Wulff et
-#' al., 2019; Wulff et al., 2021). Common trajectory types are linear
+#' al., 2019; Wulff et al., 2022). Common trajectory types are linear
 #' trajectories, mildly and strongly curved trajctories, and single and multiple
 #' change-of-mind trials (see also \link{mt_map}). \code{mt_cluster} can tease
 #' these types apart.
@@ -32,7 +32,7 @@
 #' top-left corner of the coordinate system (\link{mt_remap_symmetric} or
 #' \link{mt_align} can be used to achieve this). Furthermore, it is recommended
 #' to use length normalized trajectories (see \link{mt_length_normalize}; Wulff
-#' et al., 2019).
+#' et al., 2019, Wulff et al., 2021).
 #'
 #' @inheritParams mt_time_normalize
 #' @param save_as a character string specifying where the resulting data should
@@ -86,10 +86,15 @@
 #' @references Wulff, D. U., Haslbeck, J. M. B., Kieslich, P. J., Henninger, F.,
 #'   & Schulte-Mecklenbeck, M. (2019). Mouse-tracking: Detecting types in
 #'   movement trajectories. In M. Schulte-Mecklenbeck, A. Kühberger, & J. G.
-#'   Johnson (Eds.), \emph{A Handbook of Process Tracing Methods} (pp. 131-145). New York, NY:
-#'   Routledge.
+#'   Johnson (Eds.), \emph{A Handbook of Process Tracing Methods} (pp. 131-145).
+#'   New York, NY: Routledge.
+#'   
+#'   Wulff, D. U., Kieslich, P. J., Henninger, F., Haslbeck, J. M. B., &
+#'   Schulte-Mecklenbeck, M. (2021). \emph{Movement tracking of cognitive
+#'   processes: A tutorial using mousetrap.} PsyArXiv.
+#'   \doi{10.31234/osf.io/v685r}
 #'    
-#'   Wulff, D. U., Haslbeck, J. M. B., & Schulte-Mecklenbeck, M. (2021).
+#'   Wulff, D. U., Haslbeck, J. M. B., & Schulte-Mecklenbeck, M. (2022).
 #'   \emph{Measuring the (dis-)continuous mind: What movement trajectories
 #'   reveal about cognition}. Manuscript in preparation.
 #'

diff --git a/R/data.R b/R/data.R
@@ -215,18 +215,23 @@
 #' trajectory, the discrete change-of-mind trajectory, and the double discrete
 #' change-of-mind trajectory.
 #' 
-#' Mouse- and hand-trajectories often occur in types (Wulff, Haslbeck, & 
-#' Schulte-Mecklenbeck, 2017). In such cases, movement trajectory data should be
-#' analyzed in terms of discrete type assignments. To this end \link{mt_map} can
-#' be used to map mouse- or hand-trajectory to the closest of several predefined
-#' prototypes. \code{mt_prototypes} provides a core set of prototypes that has 
-#' been shown to represent well a large fraction of empirical movement 
-#' trajectories.
+#' Mouse- and hand-trajectories often occur in types. In such cases, movement
+#' trajectory data should be analyzed in terms of discrete type assignments
+#' (Wulff et al., 2021). To this end \link{mt_map} can be used to map mouse- or
+#' hand-trajectory to the closest of several predefined prototypes.
+#' \code{mt_prototypes} provides a core set of prototypes that has been shown to
+#' represent well a large fraction of empirical movement trajectories (Wulff et
+#' al., 2022).
 #' 
 #' To tailor the set of prototypes to a given study, \code{mt_prototypes} can be
 #' extended using \link{mt_add_trajectory}.
 #' 
-#' @references Wulff, D. U., Haslbeck, J. M. B., Schulte-Mecklenbeck, M. (2018).
+#' @references  Wulff, D. U., Kieslich, P. J., Henninger, F., Haslbeck, J. M.
+#'   B., & Schulte-Mecklenbeck, M. (2021). \emph{Movement tracking of cognitive
+#'   processes: A tutorial using mousetrap.} PsyArXiv.
+#'   \doi{10.31234/osf.io/v685r}
+#'   
+#'   Wulff, D. U., Haslbeck, J. M. B., Schulte-Mecklenbeck, M. (2022).
 #'   \emph{Measuring the (dis-)continuous mind: What movement trajectories
 #'   reveal about cognition}. Manuscript in preparation.
 #'   

diff --git a/R/map.R b/R/map.R
@@ -6,7 +6,7 @@
 #' prototype that produced the smallest distance.
 #' 
 #' Mouse trajectories often occur in distinct, qualitative types (see Wulff et
-#' al., 2019; Wulff et al., 2021). Common trajectory types are linear
+#' al., 2019; Wulff et al., 2022). Common trajectory types are linear
 #' trajectories, mildly and strongly curved trajectories, and single and
 #' multiple change-of-mind trials. \code{mt_map} allows to map trajectories to a
 #' predefined set of trajectory types.
@@ -22,7 +22,7 @@
 #' trajectories end in the top-left corner of the coordinate system
 #' (\link{mt_remap_symmetric} or \link{mt_align} can be used to achieve this).
 #' Furthermore, it is recommended to use length normalized trajectories (see
-#' \link{mt_length_normalize}; Wulff et al., 2019).
+#' \link{mt_length_normalize}; Wulff et al., 2019, Wulff et al., 2021).
 #' 
 #' @inheritParams mt_distmat
 #' @param prototypes a trajectory array containing the prototypes the 
@@ -51,10 +51,15 @@
 #' @references Wulff, D. U., Haslbeck, J. M. B., Kieslich, P. J., Henninger, F.,
 #'   & Schulte-Mecklenbeck, M. (2019). Mouse-tracking: Detecting types in
 #'   movement trajectories. In M. Schulte-Mecklenbeck, A. Kühberger, & J. G.
-#'   Johnson (Eds.), \emph{A Handbook of Process Tracing Methods} (pp. 131-145). New York, NY:
-#'   Routledge.
+#'   Johnson (Eds.), \emph{A Handbook of Process Tracing Methods} (pp. 131-145).
+#'   New York, NY: Routledge.
 #'    
-#'   Wulff, D. U., Haslbeck, J. M. B., & Schulte-Mecklenbeck, M. (2021).
+#'   Wulff, D. U., Kieslich, P. J., Henninger, F., Haslbeck, J. M. B., &
+#'   Schulte-Mecklenbeck, M. (2021). \emph{Movement tracking of cognitive
+#'   processes: A tutorial using mousetrap.} PsyArXiv.
+#'   \doi{10.31234/osf.io/v685r}
+#'   
+#'   Wulff, D. U., Haslbeck, J. M. B., & Schulte-Mecklenbeck, M. (2022).
 #'   \emph{Measuring the (dis-)continuous mind: What movement trajectories
 #'   reveal about cognition}. Manuscript in preparation.
 #'         

diff --git a/R/spatialize.R b/R/spatialize.R
@@ -35,6 +35,8 @@
 #' Dirk U. Wulff
 #'
 #' Jonas M. B. Haslbeck
+#' 
+#' Pascal J. Kieslich
 #'
 #' @export
 mt_length_normalize <- function(

diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.14.0.3
 pkgdown: 2.0.1
 pkgdown_sha: ~
 articles: {}
-last_built: 2021-12-29T14:44Z
+last_built: 2022-01-03T16:43Z
 
diff --git a/docs/reference/mt_check_bimodality.html b/docs/reference/mt_check_bimodality.html
diff --git a/docs/reference/mt_cluster.html b/docs/reference/mt_cluster.html
diff --git a/docs/reference/mt_length_normalize.html b/docs/reference/mt_length_normalize.html
diff --git a/docs/reference/mt_map.html b/docs/reference/mt_map.html
diff --git a/docs/reference/mt_prototypes.html b/docs/reference/mt_prototypes.html
diff --git a/man/mt_cluster.Rd b/man/mt_cluster.Rd
diff --git a/man/mt_length_normalize.Rd b/man/mt_length_normalize.Rd
diff --git a/man/mt_map.Rd b/man/mt_map.Rd
diff --git a/man/mt_prototypes.Rd b/man/mt_prototypes.Rd