Installing trackR should go smoothly on all major operating systems (Mac, Windows, “Ubuntu-like” Linux). There are a few steps to follow before installing the package itself in order to install all the necessary dependencies.

All installation steps are described below.



1 - Installing OpenCV

trackR uses the powerful computer-vision library OpenCV in order to load and process videos and images. Installing OpenCV can be a daunting task if you are not used to compiling complex software from source. For this reason, we have created ROpenCVLite, a helper R package that will take care of this process for you.

Please go to https://swarm-lab.github.io/ROpenCVLite/articles/install.html and follow the instructions there to install OpenCV on your system. There are slight differences between the installation processes for Mac, Windows, and Linux, so make sure to follow those that are for your operating system. The installation process should be straightforward (just a few buttons or links to click here and there) but the compilation of OpenCV will take some time (10 to 20 minutes depending on your machine and operating system). Make yourself a nice cup of tea or coffee and relax in the meantime.

Once you have installed OpenCV via ROpenCVLite, you can follow the rest of the installation instructions for trackR below.


2 - Installing trackR

Once OpenCV is ready, you can install trackR and the rest of its dependencies by simply typing the following command in your R console:

remotes::install_github("swarm-lab/trackR")

You are now ready to proceed to the rest of the tutorials!