-
Notifications
You must be signed in to change notification settings - Fork 17
/
README.Rmd
55 lines (35 loc) · 3.01 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
---
output:
github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# mousetrap <img src="man/figures/mousetrap.png" align="right" alt="" width="120" />
[](https://CRAN.R-project.org/package=mousetrap)
[](https://doi.org/10.5281/zenodo.596640)
[](https://CRAN.R-project.org/package=mousetrap)
Mouse-tracking, the analysis of mouse movements in computerized experiments, is a method that is becoming increasingly popular in the cognitive sciences.
The `mousetrap` package offers functions for importing, preprocessing, analyzing, aggregating, and visualizing mouse-tracking data.
## General Information
The `mousetrap` package is developed by Pascal Kieslich, Dirk Wulff, Felix Henninger, and Jonas Haslbeck. It is published under the GNU General Public License (version 3).
An overview of the functions in this package can be found [online](http://pascalkieslich.github.io/mousetrap/reference/mousetrap.html).
It can also be accessed from within R using `?mousetrap` once the package has been loaded.
Please see [news](http://pascalkieslich.github.io/mousetrap/news/) for a summary of changes in the package. Questions about using `mousetrap` can be asked in the [forum](https://forum.cogsci.nl/index.php?p=/categories/mousetrap).
The `mousetrap` package offers functions for importing mouse-tracking data in different formats and from various sources. One option to collect mouse-tracking data is by using the open-source graphical experiment builder [OpenSesame](https://osdoc.cogsci.nl/) in combination with the [mousetrap-os plugin](https://github.com/pascalkieslich/mousetrap-os).
## Installation
The current stable version is available on CRAN and can be installed via `install.packages("mousetrap")`.
To install the latest development version from GitHub, you need the `devtools` package .
The development version can be installed via `devtools::install_github("pascalkieslich/mousetrap@master")`.
## Questions
Questions about using `mousetrap` can be asked in the [forum](https://forum.cogsci.nl/index.php?p=/categories/mousetrap).
## Citation
If you use the `mousetrap` package in your published research, we kindly ask that you cite the associated preprint:
Wulff, D. U.\*, Kieslich, P. J.\*, Henninger, F., Haslbeck, J. M. B., & Schulte-Mecklenbeck, M. (2023). _Movement tracking of psychological processes: A tutorial using mousetrap._ PsyArXiv. https://doi.org/10.31234/osf.io/v685r
## Acknowledgments
We thank Johanna Hepp for helpful comments on the documentation of this package and Monika Wiegelmann for testing a development version. This work was supported by the University of Mannheim's Graduate School of Economic and Social Sciences, which is funded by the German Research Foundation.