indPeriodogramSleep {phase} | R Documentation |
Periodogram plot for sleep data of individual flies
Description
This function generates a periodogram for the sleep data of a single fly. The output of this function is a plotly object.
Usage
indPeriodogramSleep(
data,
bin = 30,
method = "ChiSquare",
low.per = 16,
high.per = 32,
alpha = 0.05,
time.res = 20,
ind = 1
)
Arguments
data |
Input data file. The input for this function must be an output from one of either sleepData(), deepSleepData() or lightSleepData() functions. See ??sleepData(), ??deepSleepData() and/or ??lightSleepData(). |
bin |
Intervals in which input data is saved (in minutes). This defaults to 30. |
method |
Choose the method for performing time-series analysis. Currently, three methods are implemented for analysis - "ChiSquare", "Autocorrelation", and "LombScargle". This defaults to "ChiSquare". |
low.per |
Choose the lowest period (in hours) for analysis. This defaults to 16. |
high.per |
Choose the highest period (in hours) for analysis. This defaults to 32. |
alpha |
Choose the significance level for periodogram analysis. This defaults to 0.05. |
time.res |
Resolution of periods (in minutes) to analyse while using the ChiSquare periodogram. For instance, if users wish to scan periods from low.per to high.per in the following manner: 16, 16.5, 17, 17.5, and so on, then time.res must be 30. This defaults to 20. |
ind |
The channel number (or individual) whose periodogram must be plotted. |
Value
A plotly
htmlwidget
with the individual periodogram of a user defined fly.
Examples
td <- trimData(data = df, start.date = "19 Dec 20", start.time = "21:00",
n.days = 3, bin = 1, t.cycle = 24)
sd <- sleepData(td)
ind.periodogram.sleep <- indPeriodogramSleep(data = sd, ind = 10)