combine_inputs: Distill the dataset and analysis performed in the idocr...

View source: R/plot.R

combine_inputsR Documentation

Distill the dataset and analysis performed in the idocr workflow to the datasets required for plotting

Description

A tracker dataset where every record represents the position of one animal in one timepoint is required to plot the trace

Usage

combine_inputs(
  dataset,
  analysis,
  plot_preference_index = TRUE,
  plot_mask = NULL
)

Arguments

dataset

List of raw data including:

  • roi: every row records the position of one animal at one point in time

  • controller: every row records the status of all IDOC stimulus at one point in time

  • limits

  • border

analysis

List of processed data including:

  • annotation: every row is a decision zone exit and its appetitive / aversive value

  • pi: preference index scored by each animal

plot_preference_index

Whether to show the scored preference index with the region id on the facet label (TRUE), or just the region id (FALSE)

plot_mask

If not NULL, the plot contains data contained within the interval's start and end (s)

Details

A corssing dataset where every record represents a decision zone exit of one animal is required to show the exits in the plot


shaliulab/idocr documentation built on June 1, 2025, 4:59 p.m.