collapse = TRUE,
  comment = "#>"


  1. Preparing your data
    1. Structuring the study area
    2. Creating a distances matrix
  2. explore()
    1. Processes behind explore()
    2. Inspecting the explore() results
  3. migration()
    1. Processes behind migration()
    2. Inspecting the migration() results
    3. One-way efficiency estimations
  4. residency()
    1. Processes behind residency()
    2. Inspecting the residency() results
    3. Multi-way efficiency estimations
  5. Manual mode
  6. Errors and messages

Results within R

If you ran the explore function and stored it into an object (i.e. output <- explore(...)), this object will now be a list, containing all the useful results actel has compiled for you:


The detections list contains the detections found in your detections file which match your target tags, split by each of the tags. This is the base data with which actel worked. Here is an example:

|Timestamp |Receiver |CodeSpace |Signal |Transmitter |Standard.Name |Array | |:-------------------|:--------|:---------|:------|:-----------|:-------------|:------| |2018-04-18 19:07:45 |130763 |R64K |4701 |R64K-4701 |St.2 |River1 | |2018-04-18 19:08:06 |130763 |R64K |4701 |R64K-4701 |St.2 |River1 | |2018-04-18 19:56:39 |130766 |R64K |4701 |R64K-4701 |St.7 |River1 | |2018-04-18 20:01:11 |126324 |R64K |4701 |R64K-4701 |St.5 |River1 | |2018-04-18 20:13:43 |126324 |R64K |4701 |R64K-4701 |St.5 |River1 | |2018-04-18 20:15:11 |126324 |R64K |4701 |R64K-4701 |St.5 |River1 |


The valid.detections object only contains the detections that were deemed valid during the analysis.


The spatial list contains the stations, release sites and some more summary information. This object may come in handy if you have to go back to your results some time after you completed the analysis, so you can verify the study area design and match the stations names to their locations.


The deployments data frame is similar to t deployments.csv file, with the exception that unique serial numbers have been created for receivers which were deployed more than once.


The arrays list contains detailed information for each array: Which arrays are directly before, which arrays are direcly after, which arrays are valid efficiency peers, which arrays are directly OR indirectly after, and more.


The movements list contains the movement events created during the detection sorting process. These records can become very useful if you need to go back to a given fish and inspect its behaviour in more detail. Here is an example:

|Array | Detections|First station |Last station |First time |Last time |Time travelling |Time on array | |:------|----------:|:-------------|:------------|:-------------------|:-------------------|:---------------|:-------------| |River1 | 92|St.2 |St.2 |2018-04-18 19:07:45 |2018-04-18 23:27:29 |NA |4:19 | |River2 | 1|St.11 |St.11 |2018-04-18 23:49:16 |2018-04-18 23:49:16 |0:21 |- | |River3 | 3|St.12 |St.12 |2018-04-19 01:52:34 |2018-04-19 01:57:01 |2:03 |0:04 | |River4 | 10|St.13 |St.13 |2018-04-19 03:35:44 |2018-04-19 03:42:17 |1:38 |0:06 | |Bay1 | 52|St.16 |St.17 |2018-04-20 05:33:51 |2018-04-20 06:12:20 |25:51 |0:38 | |Bay1 | 69|St.17 |St.16 |2018-04-20 12:00:31 |2018-04-20 13:00:36 |5:48 |1:00 |


The valid.movements represents a refined version of the movements object, where all movements deemed invalid during the analysis were removed.


The times data frame contains the timestamps of first valid detection in each array, for each fish. These are used to draw the circular plots in the report (like the ones below), but you can also use them to test for differences between groups!

drawing drawing


If a valid distance matrix was supplied for the analysis, it will be returned together with the results. This allows you to easily check speeds between specific movements of particular interest, and can serve as a basis for other relevant metrics.

Results in your working directory

On top of the results stored in your R session, actel saves some additional information in your working directory:


To make sure that you don't accidentally lose your results, actel stores them right away in the target folder. The results present in this file are the same as the ones you obtain directly in your R console (see above).


This log acts as a carbon copy of the analysis. It contains everything: summary information, errors, warnings and messages and the options you have taken while the analysis was running. It is worth keeping it in case you need to find out the reasoning behind some result. To avoid overwriting when conducting multiple analysis, the actel.log.txt file is preceded by the timestamp of when it was created (e.g. '2019-05-').

If something goes wrong during the analysis, the report will be saved with the sufix "STOP".


Deployed receivers may pick up stray tags that came in range during the study period. Actel stores a brief summary of these tags in the stray_tags.csv file, in case you are interested in knowing more about these tags, or perhaps share the codes with your colleagues.

actel_explore_report.html (if report = TRUE)

This is the main non-R output. If you activated the report option, actel will compile an html report for you. For the explore function, this report contains the following sections:

  1. Summary

Contains brief information on the study. It is useful to check up if anything looks wrong (e.g. the number of target tags, the data range).

  1. Stations, Deployments and Releases

These sections contain tables listing the stations, deployments and release sites considered for the analysis. Any unknown receivers found during the analysis will also show up here. Since the station names can vary wildly, actel creates standard names for your stations (e.g. "St.1", "St.2"). When looking at the individual detection graphics, you can refer back to the spatial table to match the standard names to the respective station names.

  1. Warning messages

These represent warnings, errors and particularly important messages that were displayed during the analysis. By having them extracted and put together here, you can easily find out what went wrong.

  1. User comments

Should you type in any comments during the analysis, they will be displayed here, so you can quickly remember that lingering detail you didn't want to forget while looking at the fish's movement table.

  1. Biometrics

Actel crawls through you biometrics file in search for columns containing the keywords length, weight or mass. Should it find any matching column, it will print boxplots of the distribution of the selected variables, split by each fish group listed in the same file. This can be very helpful in quickly finding typos in the data (e.g. a displaced decimal separator).

  1. Time of arrival at each array

For each of your study area's arrays, a circular plot will be drawn of the first arrival time of each fish. The fish are grouped by the groups listed in the biometrics.csv file. These plots are saved in .svg format in the Report folder, so you can easily use them elsewhere, if needed.

  1. Graphics of detected tags

This section contains a plot for each of your target tags, showing all the detections found in the data for the respective fish. The detections are coloured by array. The vertical black dashed line shows the time of release.

The full dark-grey line moving between detections shows the movement events considered valid, while the dashed dark-grey line shows the movement events considered invalid. The movement event lines move straight between the first and last station of each event (i.e. in-between detections will not be individually linked by the line).

Note that fish where you had to manually intervene during the analysis will be highlighted with a yellow border, and fish that were manually overridden through the override argument will be highlighted with a red border.

Lastly, the total number of detections for the fish is displayed in the header, between brackets.

  1. Actel log

This section contains the same information as the actel log saved in your target folder. It is useful to have a look at a few things. For example, the number of target tags, the detection data range or the number of ALS (i.e. receivers) can help you spot any missing data (i.e. if you tagged 100 fish and had only 80 target tags, some tags are missing from your input files!).

'Report' folder (if report = TRUE)

Activating the report option will trigger the creation of this folder. This folder contains all the pieces used to build the actel report described above. This allows you to have a look at the raw graphics used in the report.

What if actel has miss-assigned something?

Fish with strange behaviour can be complicated to analyse. While actel's functions have been designed to deal with this as best as possible, you can always enter manual mode if you find out that actel has miss-assigned something. I.e. has a movement event been invalidated that seems valid, or vice-versa? Are part of the movements detected characteristic of predator behaviour?

More detailed analyses

To advance into more detailed analyses, you can proceed either to the migration() analysis or to the residency() analysis. These will use the movement events created here to extract more complex metrics!

Back to top.

hugomflavio/actel documentation built on Jan. 11, 2020, 11:36 a.m.