Skip to content

imotionsApi v2.8.3 - minor modification of the getAOIRespondentData function to provide more info about the mouse. #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agrappe merged 1 commit into from
Nov 13, 2025
Merged

imotionsApi v2.8.3 - minor modification of the getAOIRespondentData function to provide more info about the mouse. #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions imotionsApi/R/imotionsApi.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1492,14 +1492,14 @@ privateDownloadData <- function(study, sensor, signalsName = NULL) {



#' Get the inOutGaze information, inOutMouseClick information and AOI's intervals for a specific AOI/respondent
#' Get the inOutGaze information, inOutMouse information and AOI's intervals for a specific AOI/respondent
#' combination. Note that imAOI object, by definition, are linked to a specific stimulus.
#'
#' The inOutGaze data.table has a IsGazeInAOI column that is TRUE when a gaze was recorded inside the AOI and FALSE if
#' outside (timestamps correspond to the actual gazepoint Timestamp). To reduce the size of the file created,
#' only timestamps where a change of value occur are given. If the AOI was never active, the table is empty.
#'
#' The inOutMouseClick data.table has a IsMouseInAOI column that is TRUE when a click was recorded inside the AOI and
#' The inOutMouse data.table has a IsMouseInAOI column that is TRUE when a click was recorded inside the AOI and
#' FALSE if outside (timestamps correspond to the actual Timestamp of each click). If no click was recorded or if the
#' AOI was never active, the table is empty.
#'
Expand All @@ -1508,7 +1508,7 @@ privateDownloadData <- function(study, sensor, signalsName = NULL) {
#' @param respondent An imRespondent object as returned from \code{\link{getRespondents}}.
#'
#' @importFrom dplyr mutate_at %>%
#' @return A list with inOutGaze/inOutMouseClick information for the specific AOI/respondent combination and an
#' @return A list with inOutGaze/inOutMouse information for the specific AOI/respondent combination and an
#' imIntervalList object (data.table) composed of the start, end, duration, id and name of this AOI.
#' @export
#' @examples
Expand Down Expand Up @@ -1573,8 +1573,8 @@ getAOIRespondentData <- function(study, AOI, respondent) {
intervals <- data.table(fragments.start = NA_real_, fragments.end = NA_real_)
inOutGaze <- data.table(matrix(data = NA_integer_, ncol = 2, nrow = 0))
names(inOutGaze) <- c("Timestamp", "IsGazeInAOI")
inOutMouseClick <- data.table(matrix(data = NA_integer_, ncol = 2, nrow = 0))
names(inOutMouseClick) <- c("Timestamp", "IsMouseInAOI")
inOutMouse <- data.table(matrix(data = NA_integer_, ncol = 3, nrow = 0))
names(inOutMouse) <- c("Timestamp", "IsMouseInAOI", "IsMouseDown")
} else {
data$id <- AOI$id

Expand All @@ -1588,7 +1588,10 @@ getAOIRespondentData <- function(study, AOI, respondent) {
inOutGaze <- inOutGaze[, c("Timestamp", "IsGazeInAOI")]

# Get clicks events
inOutMouseClick <- data[(data$IsMouseDown), c("Timestamp", "IsMouseInAOI")]
mouseChange <- data[, c(IsMouseInAOI = unique(IsMouseInAOI), .SD[1]), by = rleid(IsMouseInAOI)][, -1]
mouseChange <- rbind(mouseChange, data[IsMouseDown == TRUE, ])

inOutMouse <- mouseChange[order(Timestamp), c("Timestamp", "IsMouseInAOI", "IsMouseDown")]
}

intervals <- intervals[, let(fragments.duration = intervals$fragments.end - intervals$fragments.start,
Expand All @@ -1598,7 +1601,7 @@ getAOIRespondentData <- function(study, AOI, respondent) {

intervals[is.na(intervals$fragments.duration), ]$fragments.duration <- 0
intervals <- createImObject(intervals, "Interval")
return(list(inOutGaze = inOutGaze, inOutMouseClick = inOutMouseClick, intervals = intervals))
return(list(inOutGaze = inOutGaze, inOutMouse = inOutMouse, intervals = intervals))
}


Expand Down
41 changes: 21 additions & 20 deletions imotionsApi/tests/testthat/test-getAOIRespondentData.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,14 +274,15 @@ test_that("local return - inOutGaze for a specific AOI/respondent pair", {
1e-2, info = "wrong in/off Timestamp")
})

test_that("local return - inOutMouseClick for a specific AOI/respondent pair", {
inOutMouseClick <- mockedGetAOIRespondentData(study, AOI, respondent, AOIDetailsFile)$inOutMouseClick

# Check inOutMouseClick data.table
expect_named(inOutMouseClick, c("Timestamp", "IsMouseInAOI"), info = "wrong column names")
expect_equal(nrow(inOutMouseClick), 1, info = "should have 1 in/off values")
expect_true(inOutMouseClick$IsMouseInAOI, "wrong value")
expect_equal(inOutMouseClick$Timestamp, 22109.5, 1e-2, info = "wrong in/off Timestamp")
test_that("local return - inOutMouse for a specific AOI/respondent pair", {
inOutMouse <- mockedGetAOIRespondentData(study, AOI, respondent, AOIDetailsFile)$inOutMouse

# Check inOutMouse data.table
expect_named(inOutMouse, c("Timestamp", "IsMouseInAOI", "IsMouseDown"), info = "wrong column names")
expect_equal(nrow(inOutMouse[(IsMouseDown), ]), 1, info = "should have 1 mouse click value")
expect_equal(nrow(inOutMouse[!(IsMouseDown), ]), 7, info = "should have 7 mouse in/out values")
expect_true(inOutMouse[(IsMouseDown), ]$IsMouseInAOI, "wrong value")
expect_equal(inOutMouse[(IsMouseDown), ]$Timestamp, 22109.5, 1e-2, info = "wrong in/off Timestamp")
})

# Modify AOIDetailsFile so it returns an empty event (no gaze, mouse click in AOI)
Expand All @@ -290,8 +291,8 @@ AOIDetailsFile$fileId <- "../data/aoiEmptyRespondentData.pbin"
test_that("local check - work if no gazes or mouse click in", {
resultList <- mockedGetAOIRespondentData(study, AOI, respondent, AOIDetailsFile)

expect_named(resultList, c("inOutGaze", "inOutMouseClick", "intervals"), info = "wrong names")
expect_equal(nrow(resultList$inOutMouseClick), 0, info = "should be empty (no click)")
expect_named(resultList, c("inOutGaze", "inOutMouse", "intervals"), info = "wrong names")
expect_equal(nrow(resultList$inOutMouse), 1, info = "should only have one value (no mouse in or mouse click)")
expect_equal(nrow(resultList$inOutGaze), 1, info = "should only have one value (no gaze in)")
expect_false(resultList$inOutGaze$IsGazeInAOI, info = "wrong value")
})
Expand All @@ -302,11 +303,11 @@ AOIDetailsFile$fileId <- "../data/AOInotDefined.pbin"

test_that("local check - work if no AOI exposure", {
resultList <- mockedGetAOIRespondentData(study, AOI, respondent, AOIDetailsFile)
expect_named(resultList, c("inOutGaze", "inOutMouseClick", "intervals"), info = "wrong names")
expect_named(resultList, c("inOutGaze", "inOutMouse", "intervals"), info = "wrong names")

# Check inOutMouseClick
expect_named(resultList$inOutMouseClick, c("Timestamp", "IsMouseInAOI"), info = "wrong column names")
expect_equal(nrow(resultList$inOutMouseClick), 0, info = "should be empty (no exposure)")
# Check inOutMouse
expect_named(resultList$inOutMouse, c("Timestamp", "IsMouseInAOI", "IsMouseDown"), info = "wrong column names")
expect_equal(nrow(resultList$inOutMouse), 0, info = "should be empty (no exposure)")

# Check inOutGaze
expect_named(resultList$inOutGaze, c("Timestamp", "IsGazeInAOI"), info = "wrong column names")
Expand Down Expand Up @@ -382,12 +383,12 @@ test_that("remote return - inOutGaze for a specific AOI/respondent pair", {
expect_equal(inOutGaze$Timestamp, c(44639, 46091, 46639, 49919, 50381), 1e-2, info = "wrong in/off Timestamp")
})

test_that("remote return - inOutMouseClick for a specific AOI/respondent pair", {
inOutMouseClick <- mockedGetAOIRespondentData(study_cloud, AOI_cloud, respondent, aoiDetails)$inOutMouseClick
test_that("remote return - inOutMouse for a specific AOI/respondent pair", {
inOutMouse <- mockedGetAOIRespondentData(study_cloud, AOI_cloud, respondent, aoiDetails)$inOutMouse

# Check inOutMouseClick data.table
expect_named(inOutMouseClick, c("Timestamp", "IsMouseInAOI"), info = "wrong column names")
expect_equal(nrow(inOutMouseClick), 0, info = "should have 0 in/off values")
# Check inOutMouse data.table
expect_named(inOutMouse, c("Timestamp", "IsMouseInAOI", "IsMouseDown"), info = "wrong column names")
expect_equal(nrow(inOutMouse), 1, info = "should have only one value (never entered)")
})

AOIDetailsPath_cloud <- "../data/AOIDetails_cloud_dynamic.json"
Expand All @@ -407,5 +408,5 @@ test_that("remote return - intervals should work on dynamic AOIs", {

test_that("remote return - should work when inout data is already loaded", {
resultList <- mockedGetAOIRespondentData(study_cloud, AOI_cloud_inout, respondent, aoiDetails_inout)
expect_named(resultList, c("inOutGaze", "inOutMouseClick", "intervals"), info = "wrong names")
expect_named(resultList, c("inOutGaze", "inOutMouse", "intervals"), info = "wrong names")
})
Loading