cat_max: Length of longest continuous cluster above/below threshold

In steffenhartmeyer/lightdosimetry: Functions for quantifying personal light exposure data

Length of longest continuous cluster above/below threshold

Description

Length of longest continuous cluster above/below threshold

Usage

cat_max(
  lightVar,
  threshold,
  sampling_int = NULL,
  unit_out = NULL,
  loop = FALSE,
  as_df = TRUE,
  wide = TRUE
)

Arguments

lightVar	Numeric vector containing the light data.
threshold	Single numeric value or vector specifying threshold intensities. The sign indicates above/below (see threshold).
sampling_int	Numeric. Sampling interval in seconds. If not specified (default), no time scaling will be performed.
unit_out	Character. Time unit of output. Possible values are ("seconds", "minutes", "hours", "days"), which can be abbreviated. If not specified (default), no time scaling will be performed.
loop	Logical. Should the data be looped? Defaults to FALSE.
as_df	Logical. Should the output be returned as a data frame? Defaults to TRUE.
wide	Logical. Should the output be returned in wide format? Defaults to TRUE.

Value

Data frame or matrix with pairs of threshold and calculated values. If wide is TRUE then variable names will be concatenated with the threshold.

steffenhartmeyer/lightdosimetry documentation built on Jan. 29, 2024, 12:48 p.m.