PAMpal (version 1.4.4)

runIciReview: Run ICI Review App

Description

Runs a Shiny app that shows three plots - the ICI (time to next detection) over time, histogram of ICI values, and the average waveform of an event. Average waveform plot is only present if calculateEchoDepth has been run first, otherwise IPI and average waveform data will not be present. ICI plots have a red line showing the modal ICI of the event, and average waveform plot has a red line of the estimated IPI level. All plots can be interacted with by clicking on a location to select a new ICI / IPI (called the "User ICI/IPI") that will be shown in blue. "Save ICI/IPI" buttons can be pressed to use save this "User" value as the new All_ici or ipiMax value. "Remove ICI/IPI" buttons can be pressed to set these values to NA, which should be done in cases where no apparent ICI/IPI exists from the plot. The "Reset" button can be used to restore the original modal ICI and estimated IPI values.

Usage

runIciReview(x, maxIci = 2.5)

Value

the object as x, with potentially updated All_ici

and ipiMax measures for some events depending on user activity

Arguments

x

an AcousticStudy object that has been processed with calculateEchoDepth

maxIci

maximum ICI value (seconds) to display on plots

Author

Taiki Sakai

Examples

# average waveform/IPI estimates not present because
# calculateEchoDepth must be run first for those to exist
if(interactive()) {
data(exStudy)
exStudy <- runIciReview(exStudy)
}