triact package for R: Analyzing the lying behavior of cows from accelerometer

\ This vignette contains executable examples for the intended use of the R package triact. Most of the functionalities are presented with default parameters. We recommend that you also read the help pages to learn more about the many parameters that can be used to customize the behavior of the methods in triact. Furthermore, background and rationale of the implemented analyses are described in detail in the following publication:

\

Simmler M., Brouwers S. P., 2024. triact package for R: Analyzing the lying behavior of cows from accelerometer data. PeerJ, 12:e17036. https://doi.org/10.7717/peerj.17036.

\

Setup

library(triact)

\ Since triact is typically used with accelerometer data with sampling frequency of \≥1 Hz, it is advisable to set R's global option digits.secs to >=1 in order to enable the printing of fractional seconds.

options(digits.secs = 1)

\ Via the global option triact_table the type of tables returned by triact can be specified. Options are "data.frame" (the default), "tibble", and "data.table".\

options(triact_table = "data.frame")

\ \

Getting help

All functionalities of the triact R package are documented on the help page of the Triact R6 class.\

?Triact

\ \

Inspecting the example data

The triact R package includes two raw data files from triaxial accelerometers (MSR145, MSR Electronics, Switzerland) attached to the left hind leg of dairy cows. The sampling frequency was 5 Hz. Each file represents one day of recording of one cow.\

input_dir <-  system.file("extdata", package = "triact") 

files <- list.files(input_dir)

print(files)

\ Inspecting one of the files reveals a file header and the semicolon-separated data starting after the line with "*Data". This is an example of what files imported by triact might look like. However, triact can handle any kind of delimiter-separated text files, with or without an arbitrary file header (which is ignored during import).\

cat(paste(readLines(file.path(input_dir, files[1]), n = 30), collapse = "\n"))

\ \

Importing data

Importing from raw files

The typical triact workflow starts by creating a new object of the Triact class.\

my_triact <- Triact$new()

\

Acceleration data is then imported into the Triact object (here named ‘my_triact’). The $load_files() method can be used to import any raw data files, which are delimiter-separated text files. If you are starting with a new file format you may want to select one or a few (small) files to find out how to specify the method's argument to enable correct import from the file(s). Once this is done, you move on to process all your files. Examine your file format in a plain text editor or in R (as above).

my_triact$load_files(input = input_dir,
                     id_substring = c(1, 5),
                     timeFwdUpRight_cols = c(1, -2, 3, -4),
                     time_format = "%Y-%m-%d %H:%M:%OS",
                     tz = "Europe/Zurich",
                     skip = "DATA",
                     sep = ";",
                     header = FALSE,
                     dec = ".")

\

The parameters as used above in the call of $load_files() have the following effects:


**(a)** Axis directions of the MSR145 accelerometer (MSR Electronics, Switzerland).
**(b)** Directions as used in the *triact* R package. Shown is the situation with the accelerometer on the outside of the left hind leg as used to collect the example data.

\ Of the optional arguments that specify details about your file format, you may not need to specify many, because by default most of them are inferred from the data. In the case of the example data, you can reduce the arguments to:

my_triact$load_files(input = input_dir,
                     id_substring = c(1, 5),
                     timeFwdUpRight_cols = c(1, -2, 3, -4),
                     skip = "DATA")

\

Once the data has been imported, you can use the `$data' field to inspect the imported raw data and (later) added analyses at any time during the workflow.

head(my_triact$data)
str(my_triact$data)

⚠️ Warning

Correct mapping of your data to the body relative direction as used in triact is necessary for correct determination of the lying/standing posture and the lying laterality (lying side). Therefore, special care should be taken when specifying the parameter timeFwdUpRight_cols.

If you are unsure of the directions of your accelerometer's XYZ data, you can determine them by experimentation. If the axis in question is pointing up, it should measure +1 g at rest. Note that accelerometers measure proper acceleration which is relative to free fall, so the gravitational component points skywards (reaction force of the ground).


ℹ NOTE 1

If you suspect that you have accidentally mounted some of your accelerometers 180° rotated in the sagittal plane, but you don't know which raw data files are affected, you should call the $check_orientation() method after loading the data into the Triact object. This method will identify such "upside down" data and correct it accordingly by multiplying the up and forward axes by -1.


ℹ NOTE 2

You can import multiple files from the same cow, i.e., multiple files with the same id as extracted from file names according to what you specify via the id_substring parameter. But the data with the same cow id must follow each other without gaps in time. If you have gaps, you should use unique ids for the time series without gaps, e.g. you may need to use the cow identifier in combination with the date as a unique id.


ℹ NOTE 3

It can take a long time to import many files. You can speed things up by setting the parallel parameter of $load_files() to > 1, which allows files to be read in parallel. See ?Triact for more information.


\

Importing from a data.frame

Alternatively to importing from raw data files with load_files(), you can read your files with your own routine and then use the $load_table() method to import a data.frame into the Triact object. Column names and data types of the data.frame must be exactly as described in ?Triact. An example data.frame, cows_5hz, is provided by the triact package.

A description of the example data.frame can be found on its help page.

?cows_5hz
str(cows_5hz)

\

Create new Triact object and import cows_5hz.

my_triact <- Triact$new()
my_triact$load_table(cows_5hz)

\ \

Adding analyses

Calling add_... methods triggers analyses of lying behavior and the calculation of proxies for the level of physical activity. The results of the analyses are obtained for each time point of your accelerometer data and added in new columns to the tabular data in the Triact object.

\

Detecting standing and lying posture

The $add_lying() method performs the classification into lying and standing posture. The results are (silently) added to the data in the Triact object as a logical column named lying, where TRUE indicates lying and FALSE standing. Additionally, lying and standing bouts are uniquely numbered (per cow or ID) in column bout_nr.

my_triact$add_lying()
str(my_triact$data)

ℹ NOTE

The $add_lying() method comes with many parameters that allow you to tweak the underlying algorithm. With the default parameters, you can expect good results if your accelerometer sampling frequency is \≥1 Hz. See ?Triact and Simmler & Brouwers (2024) for explanations.


Detecting lying laterality

The $add_side() method performs the determination of lying laterality (lying side). The results are (silently) added to the data in the Triact object as a factor column named side, with levels 'L' (left) and 'R' (right). During standing posture, side is NA (not available). Crucial for correct determination of the lying side is the correct specification of which hind leg the accelerometer was mounted on (parameter left_leg = TRUE for left, or FALSE for right).

my_triact$add_side(left_leg = TRUE)
str(my_triact$data)

\

Calculating proxies for the level of physical activity

The $add_activity() method performs the calculation of proxies for the level of physical activity of the cow(s). By default, the L2 norm of the vector of the dynamic body acceleration (DBA) is calculated. It is 'adjusted' to a value of zero during lying bouts (prefix Adj), i.e., periods when cows are lying are considered as 'inactive' by definition. The results are (silently) added to the data in the Triact object as numeric column named AdjL2DBA.

my_triact$add_activity()
str(my_triact$data)

ℹ NOTE 1

You can select several proxies for the level of physical activity, namely the L1 and L2 norms of DBA and Jerk. Use the norm and dynamic_measure parameters to do this. See Simmler & Brouwers (2024) for a discussion of these proxies.


ℹ NOTE 2

Calculating DBA-based proxies involves a filtering step that can be tuned with several parameters (see ?Triact). With the default parameters, you can expect good results if your accelerometer sampling frequency is \≥1 Hz.


\

Summarizing results

The $summarize... methods are used to summarize the analyses added to the Triact object per time period, representing either the standing/lying bouts or regular intervals, e.g. 1 h or 24 h.

\

Summarizing per lying/standing bout

With $summarize_bouts() a summary is created for the individual lying and standing bouts, with duration, mean activity, and lying side (for a lying bout). There is a help page with a description of the output.

?bout_summary
bouts_summary <- my_triact$summarize_bouts()

\

In the output you can see that the first bout per cow is not completely observed (startTime is missing) and therefor NAs are returned for measures that depend on complete observation of the bout, e.g. duration.

head(bouts_summary)

\ If only the lying bouts are of interest, the bout_type parameter can be specified accordingly. \

bouts_summary <- my_triact$summarize_bouts(bout_type = "lying")

\

You can see that the last lying bout of cow01 and the first lying bout of cow02 were incompletely observed (startTime and endTime missing, respectively). Again, NAs are returned for measures that depend on complete observation of the bout.

head(bouts_summary)

ℹ NOTE

When calling the $summarize_bouts() method with parameter calc_for_incomplete = TRUE, a complete summary is also returned for the incompletely observed bouts (first and last bout for each cow). It does this by simply assuming that the bouts were completely observed. Use this option with caution.


\

Summarizing per regular intervals

With $summarize_intervals() the summary is obtained per regular intervals, by default per hour. There is a help page with a description of the output.

?interval_summary
int_summary <- my_triact$summarize_intervals()

\

The NAs in the output are a result of incompletely observed intervals (first and last interval of each cow). The NaN on the other hand do not indicate missing information: For example, if the cow was not standing in the interval, the mean activity during standing is not zero, but cannot be calculated (thus NaN, "not a number"). \

head(int_summary)
str(int_summary)

\

The intervals can be specified quite flexibly: In case of 30 min intervals and starting 10 min after the full hour you can specify interval and lag_in_s parameters accordingly. \

int_summary <- my_triact$summarize_intervals(interval = "30 min",
                                             lag_in_s = 10 * 60)
head(int_summary)
str(int_summary)

\ With bouts = TRUE you can request that, additionally, the bouts within the intervals are summarized. For measures such as the number of lying bouts or mean lying bout duration, a weighted mean is calculated with the weights being the proportion of the individual bout overlapping with the respective interval. With side = TRUE you can additionally request a differentiation of all results by lying side. Again, NAs in the output are a result of incompletely observed intervals (first and last interval of each cow). Additionally you will sometimes find NAs in the output for summaries of bouts per interval (bouts = TRUE) that result from incompletely observed bouts (first and last bout for each cow). As bouts can span several intervals, this can affect more than just the first and the last interval. Please be aware about the difference between NA and NaN described above.

int_summary <- my_triact$summarize_intervals(bouts = TRUE,
                                             side = TRUE)
str(int_summary)

ℹ NOTE

When calling the $summarize_intervals() method with parameter calc_for_incomplete = TRUE, a complete summary will also be returned for the incompletely observed intervals (first and last interval for each cow) and for any parameter using information of incompletely observed bouts (which can affect more than just the first and last interval). It does this by simply assuming that intervals and bouts were completely observed. Use this option with caution.


Visualizing results

\ The triact package does not come with visualization capabilities. But the data can easily be accessed and plotted with base R or packages dedicated to graphics (e.g. ggplot2). The following example shows how to access the data of a single cow (here with id "cow01") and to visualize the lying behavior.\

cow_id = "cow01"

data_01 <- my_triact$data[my_triact$data$id == cow_id, ]

plot(!lying ~ time, data = data_01,
     type = "l", ylab = "", yaxt = "n", bty = "n")

lines(ifelse(side == "R", 0, NA) ~ time, data = data_01, col = "orange")
lines(ifelse(side == "L", 0, NA) ~ time, data = data_01, col = "purple")

axis(2, at = c(0, 1),
     labels = c("lying", "standing"),
     las = 1,
     lwd = 0)

legend(x = "center",
       legend = c("right", "left"),
       col = c("orange", "purple"),
       lwd = 1, bty = "n", title = "lying side")

\

Extracting posture transitions

Using $extract_liedown() and $extract_standup(), the raw acceleration data (and added analyses) of the posture transitions, i.e., lying-to-standing and standing-to-lying, can be extracted.

With default parameters, only the time of the transition, bout nr of the lying bout, and lying side (if available) are returned.

st_ups <- my_triact$extract_standup()
print(st_ups)

\

When specifying 'sec_before' and 'sec_after`, time series around the exact moment of posture transition as detected by triact are returned. The result is a list with tables (one table per posture transition).

l_downs <- my_triact$extract_liedown(sec_before = 3, sec_after = 3)

\

head(l_downs[[1]])


Try the triact package in your browser

Any scripts or data that you put into this service are public.

triact documentation built on April 12, 2025, 1:11 a.m.