The Rtrack package is for the analysis of tracking data, as obtained by the Morris water maze test. The primary motivation was to provide a fast and reproducible way of assigning spatial search strategies to the individual search paths. Based on original ideas from Richard Morris (Morris 1984), automated classification of water maze swim paths was developed by David Wolfer (Wolfer and Lipp 1992) and extended by Graziano et al. (2003) and Garthe et al. (2009) among others since then. This package is centered around a new approach using machine learning for swim path classification.
This package aims to be an easy-to-use interface for analysis of spatial tracking data. The focus, at least for this first version, is on the Morris water maze. Assigning a search strategy from a search path is not a straightforward task and a number of approaches have been proposed. Unfortunately, due to the potential complexity of the experiments and the range of computational abilities of the researchers (who are typically experimentalists with little background in programming or data analysis), many existing software solutions have not found their way into laboratory workflows. This package is built on the popular and ubiquitous R platform which runs on all commonly-used operating systems, is free and open-source (so that the cost of licencing is not a limitation) and which integrates well into existing analysis environments. The data preparation involves exporting path data from the acquisition software used (outputs from a number of sofware platforms are supported and more are being added), defining the arenas in which the experiment was performed and creating a spreadsheet with information about each track. Once the data and information spreadsheet have been prepared, the actual analysis runs in very little time (processing for 1000 tracks takes under a minute on a typical modern computer) and the data are available in R for further analysis or can be exported for analysis using other software if desired. Publication-quality graphs can be generated and exported directly from the functions in Rtrack. In addition, the raw path data can be saved to a standardised format to allow data sharing and to enhance reproducibility.
The data provided together with this vignette are from a small pilot study where mice of two strains (‘B6’ and ‘D2’) were trained in a relatively large water maze (190 cm diameter) for 3 days, then tested for a further 2 days after a platform position change (‘goal reversal’). There were 6 trials per animal per day and a total of 5 animals per strain tested. In this particular experiment, the last trial of days 3 and 5 were probe trials—where the goal platform had been removed.
In this example, an archived experiment (raw data that has been saved in the portable JSON format) is read in directly from a URL. The experiment is reconstructed, strategies calculated and plotted for a visual overview. To explore the further functionality of the package, please work through the tutorial examples below.
An ‘arena’ is a unique combination of a ‘pool’ (or the equivalent for virtual tasks) and the goals—including the goal positions. This means that any change in layout of the arena, or a goal reversal or probe trial, needs to be defined separately in its own arena description file. The description files are simple and consist of only 4–5 lines:
The units for time and x, y coordinates do not need to be specified, but these must be the same units used in the raw track files.For example, the arena description for the example file (‘Arena_SW.txt’) is:
type = mwm trial.length = 120 arena.bounds = circle 133.655 103.5381 95 goal = circle 121.8934 154.6834 10
Empty lines are ignored. Any text following the character ‘#’ is also ignored (this allows helpful comments to be embedded into the file).
The key task before analysing an experiment is to gather together all the information you need for the analysis. This is always necessary for any analysis, and is always a nasty task. Nevertheless, Rtrack uses a straightforward spreadsheet format to make this task less tedious and less confusing.
Several columns are required, these all must begin with an underscore ’_’:
read_experimentfunction. See the note on relative paths below.
read_experimentfunction. See the note on relative paths below.
?Rtrack::read_path) for a list of the supported file formats.
You can also add any other columns of factors. In the example the mouse strain has been included as well as whether the track was for a probe trial or not. The ‘Probe’ column is a bit special as it can be used to easily filter out probe trials from some plots. If you have probe trials and wish to use this feature, just add the column as shown in the example (‘Probe’ with a capital ‘P’ and values of ‘TRUE’ or ‘FALSE’ only).
If your analysis will be done in the same directory as the raw data files are in, then you can ignore this comment. If, however, your raw data are large, you may have them stored on an external disc or network volume. By specifying the
data.dir parameter, you can keep these raw data anywhere you like and even move them without having to update the experiment description spreadsheet. All file paths in the experiment description are relative to the
Look at one track to get a feel for the workflow. Firstly an arena definition must be read in. This might be different for different acquisition days. The arena is also differently defined for goal reversal trials. This object has the class ‘arena’.
arena = Rtrack::read_arena("example_data/Arena_SW.txt")
The arena is required for reading in the path (to provide calibration information).
path = Rtrack::read_path("example_data/Data/Track_1.csv", arena, id = "test", track.format = "ethovision.3.csv")
The track path/swim path (of class
rtrack_path) can now be used to collect a range of metrics. This results in a list of various secondary variables which can be used for plotting and strategy calling.
metrics = Rtrack::calculate_metrics(path, arena)
The swim path can be plotted. This representation shows the initial path in red, the direct path to the goal as a yellow broken line and the goal corridor in semi-transparent yellow. The concentric zones (wall, outer wall, annulus, centre) are shown in shades of blue.
The quadrants are defined such that the goal is centred in quadrant North. These may be shown on the plot.
Rtrack::plot_path(metrics, quadrants = TRUE)
Paths can also be plotted as a density heatmap.
Feel free to play with the colours (just please don’t use a garish ‘rainbow’ scheme). The colour scales are best defined using the ‘colorRampPalette’ function.
You can use any of the colour definitions provided in R, and reducing the number of colours in the palette gives a contour effect.
The search strategy can be called using the
rtrack_metrics object. For more information on spatial search strategies and the strategies defined in Rtrack, see the accompanying vignette “Rtrack strategy description”. The default method uses a random forest model trained on several thousands of expert-called search paths.
strategy = Rtrack::call_strategy(metrics)
rtrack_strategy object contains various information; the actual strategy call can be found in the
calls component. A confidence score is an indicator of how well the path fit the model (1 = perfect).
strategy$calls #> strategy name confidence 1 2 3 4 5 6 7 8 9 #> 1 4 scanning 0.574 0.03 0.116 0.214 0.574 0.014 0.046 0.002 0 0
Alternative strategy calling methods can be used. These can be provided by any function producing a valid
rtrack_strategy object. As an example, an alternative method is provided that implements the method of (Garthe, Behr, and Kempermann 2009). This method also returns the specialist metrics used to generate the strategy call.
strategy = Rtrack::call_mwm_strategy_garthe(metrics) strategy$calls #> strategy name meanalpha eff dtPOG dtGOAL dtOLDGOAL dtCENTER #> 1 2 random swimming 89.58 94.09 0.3 0.39 1 0.3 #> annuluszonerel wallzonerel covsurfacerel outliersrel #> 1 0.22 0.28 0.79 0.73
The experiment information is read in using metadata in a spreadsheet. See ‘Preparing the input files’ above for details on how to properly construct this file. The raw data are read in, metrics calculated and returned in a list object of class
rtrack_experiment. This is the most processor-intensive part of the workflow and an experiment will typically consist of many hundreds of tracks. Depending on the size of the experiment and the speed of your computer, this step may take several minutes (a friendly progress bar will let you know if there is time for a coffee at this step).
experiment = Rtrack::read_experiment("example_data/Experiment.xlsx", format = "Excel", data.dir = "example_data/Data")
It is trivial to parallelise this potentially time-consuming step (if perhaps you have run out of coffee). Create a multi-CPU cluster (almost all modern computers contain several CPU cores).
Add the cluster to the
read_experiment function call. Now try running the
read_experiment code again and see if this makes a difference in processing time.
experiment = Rtrack::read_experiment("example_data/Experiment.xlsx", format = "Excel", data.dir = "example_data/Data", cluster = cluster)
Remember to shut down the cluster when you’re done (or you get annoying warning messages about open connections).
The strategies can then be called for every track using any favoured method. The strategy-calling methods also take lists of
rtrack_metrics objects. The core strategy-calling method employs vectorised code and is quite fast.
strategies = Rtrack::call_strategy(experiment$metrics)
rtrack_strategy object contains, among other information, all the strategy calls combined in a
head(strategies$calls) #> strategy name confidence 1 2 3 4 5 6 #> Track_1 4 scanning 0.574 0.030 0.116 0.214 0.574 0.014 0.046 #> Track_2 6 directed search 0.516 0.000 0.000 0.000 0.004 0.000 0.516 #> Track_3 4 scanning 0.502 0.060 0.084 0.270 0.502 0.024 0.050 #> Track_4 1 thigmotaxis 0.694 0.694 0.096 0.130 0.072 0.006 0.002 #> Track_5 6 directed search 0.716 0.000 0.010 0.000 0.038 0.024 0.716 #> Track_6 6 directed search 0.596 0.006 0.044 0.004 0.232 0.018 0.596 #> 7 8 9 #> Track_1 0.002 0.000 0 #> Track_2 0.466 0.014 0 #> Track_3 0.002 0.000 0 #> Track_4 0.000 0.000 0 #> Track_5 0.212 0.000 0 #> Track_6 0.100 0.000 0
Individual metrics might be of interest for separate analysis; e.g. path length. Here, the path length has been split by mouse strain (a factor in this example experiment).
Rtrack::plot_variable("path.length", experiment = experiment, factor = "Strain", factor.colours = c(B6 = "#d40000ff", D2 = "#0169c9ff"), exclude.probe = TRUE, lwd = 1.5)
Note that the probe trials have been omitted from this plot.
The ‘summary.variables’ element shows all the metrics available
experiment$summary.variables #>  "path.length" "mean.velocity" #>  "sd.velocity" "total.time" #>  "latency.to.goal" "goal.crossings" #>  "old.goal.crossings" "coverage" #>  "mean.d.centroid" "mean.d.goal" #>  "mean.d.old.goal" "mean.d.origin" #>  "sd.d.centroid" "sd.d.goal" #>  "sd.d.old.goal" "sd.d.origin" #>  "centroid.goal.displacement" "centroid.old.goal.displacement" #>  "mean.initial.heading.error" "initial.trajectory.error" #>  "initial.reversal.error" "turning" #>  "turning.absolute" "efficiency" #>  "roaming.entropy" "time.in.zone.pool" #>  "time.in.zone.wall" "time.in.zone.far.wall" #>  "time.in.zone.annulus" "time.in.zone.goal" #>  "time.in.zone.old.goal" "time.in.zone.n.quadrant" #>  "time.in.zone.e.quadrant" "time.in.zone.s.quadrant" #>  "time.in.zone.w.quadrant"
It is also possible to create a density heatmap for many tracks together.
Rtrack::plot_density(experiment$metrics) #> Warning in Rtrack::plot_density(experiment$metrics): Multiple arena definitions #> have been used. The results may not make sense!
The warning tells us that there are data from tracks using different arenas in our ‘metrics’ list. This almost certainly does not make sense.
However, it might be interesting to look at all the reversal tracks and compare this between the different strains
b6.reversal.metrics = experiment$metrics[experiment$factors$Strain == "B6" & (experiment$factors$`_Day` == 4 | experiment$factors$`_Day` == 5)] d2.reversal.metrics = experiment$metrics[experiment$factors$Strain == "D2" & (experiment$factors$`_Day` == 4 | experiment$factors$`_Day` == 5)] par(mfrow = c(1, 2)) Rtrack::plot_density(b6.reversal.metrics, title = "B6 reversal") Rtrack::plot_density(d2.reversal.metrics, title = "D2 reversal")
The strategies can be visualised as contingency plots per trial (as in (Garthe, Behr, and Kempermann 2009)) Here two plots are made, one for each strain/factor level.
Rtrack::plot_strategies(strategies, experiment = experiment, factor = "Strain", exclude.probe = TRUE)
The last function produced two plots. These can be best saved as a multi-page PDF.
This next block of code produces a 300-page PDF including each of the paths and titled with the track ID and called strategy. This can be used to check the strategy against your visual interpretation of the path—did our software get it right?
There are many paths that are very difficult to call (even for a human) and often people will have different interpretations of which strategy is appropriate. The machine-learning method might not always get it ‘right’—but it is consistent. And that can only help reproducibility. We would be interested to hear from you if Rtrack does not perform well with your data. It may be possible to extend the package to cope with a wider range of data sources. See the help page for details on how to contact us.
The machine-learning algorithm (
call_strategy) never outputs a 0 or ‘unknown’ call. It will always assign a call based on the best match to the model. Often these ‘best matches’ are actually rather poor. It may be of interest to use a confidence threshold and discard calls that are below a certain value. We have observed during testing that confidence scores above 0.4 are typically accurate and reproducible, but many paths may not reach this level. It is possible to perform the thresholding easily using the
The thresholded experiment is a new
rtrack_experiment object and contains all the same components. The following example uses a confidence threshold of 0.4 and checks the size of the resulting
data.frame of strategy calls.
It can be seen that only 205 tracks remain at this threshold.
The remaining strategies can be plotted as a strategy plot. The missing values are simply shown as white background.
Rtrack::plot_strategies(Rtrack::threshold_strategies(strategies, 0.4), experiment = experiment, factor = "Strain", exclude.probe = TRUE)
To get a
data.frame containing all the experiment metadata, metrics and strategies for each track, it is possible to export the experiment results. The function
export_results is really intended for saving to a file, but if no filename is given, then you get the data as a
results = Rtrack::export_results(experiment)
The results can be written to file in any one of several formats. The format will be determined from the filename extension. The default, and most likely to be used in an experimental workflow, is the Excel ‘.xlsx’ format.
Rtrack::export_results(experiment, file = "Results.xlsx")
Also supported are comma-delimited values (‘.csv’, or ‘.csv2’ where decimal commas are needed) and tab-delimited text (any of ‘.tsv’, ‘txt’, ‘.tab’). You can actually use any file extension, but it will be written in that case as tab-delimited text and you’ll get a warning.
It is also possible to only export some of the results. To do this, just specify the indices or names of the tracks you would like to export.
# Export just the data for strain 'B6' b6 = experiment$factors$Strain == "B6" Rtrack::export_results(experiment, tracks = b6, file = "ResultsB6.xlsx")
Or you may wish to only export tracks with an above-threshold strategy call.
thresholded = Rtrack::threshold_strategies(strategies, 0.4) Rtrack::export_results(experiment, tracks = rownames(thresholded$calls), file = "ResultsThresholded.xlsx")
It is worthwhile noting that the order of the exported results is also determined by the order of the values given to the
rtrack_experiment object can easily be saved and reloaded into a later R session. The
.RData format is a compressed version of the
rtrack_experiment object and requires very little space.
save(experiment, file = "experiment.RData")
Load the file again (not necessary in this session, but the folowing line demonstates the command needed to read in the
.RData file we just created).
The raw data can also be exported to the widely-recognised JSON format. This allows sharing with other software.
Rtrack::export_json(experiment, tracks = "all", file = "Experiment.json")
Data saved in this way can be read back into Rtrack using the
read_experiment function with the format
recreated.experiment = Rtrack::read_experiment("Experiment.json", format = "json")
This experiment object recreated from the saved JSON file is (almost) identical to the original object. Only the export information is obviously different.
all.equal(recreated.experiment, experiment) #>  "Component \"info\": Component \"export.note\": 1 string mismatch" test.recreated.experiment = recreated.experiment # If we set 'export.note' back to empty, then the objects are identical test.recreated.experiment$info$export.note = "" identical(test.recreated.experiment, experiment) #>  TRUE
Garthe, Alexander, Joachim Behr, and Gerd Kempermann. 2009. “Adult-generated hippocampal neurons allow the flexible use of spatially precise learning strategies.” PloS One 4 (5): e5464. https://doi.org/10.1371/journal.pone.0005464.
Graziano, Alessandro, Laura Petrosini, and Alessandro Bartoletti. 2003. “Automatic recognition of explorative strategies in the Morris water maze.” Journal of Neuroscience Methods 130 (1): 33–44. https://doi.org/10.1016/S0165-0270(03)00187-0.
Morris, R. 1984. “Developments of a water-maze procedure for studying spatial learning in the rat.” Journal of Neuroscience Methods 11 (1): 47–60. http://eutils.ncbi.nlm.nih.gov/entrez/eutils/elink.fcgi?dbfrom=pubmed&id=6471907&retmode=ref&cmd=prlinks.
Wolfer, D P, and H P Lipp. 1992. “A new computer program for detailed off-line analysis of swimming navigation in the Morris water maze.” Journal of Neuroscience Methods 41 (1): 65–74. http://eutils.ncbi.nlm.nih.gov/entrez/eutils/elink.fcgi?dbfrom=pubmed&id=1578902&retmode=ref&cmd=prlinks.