nvR_circadianResponse: Non-visual circadian response

View source: R/nvR.R

nvR_circadianResponseR Documentation

Non-visual circadian response

Description

This function calculates the non-visual circadian response

Usage

nvR_circadianResponse(
  irr_mel,
  lux,
  sampling_int,
  datetime = NULL,
  sleep_onset = NULL,
  shiftModel = FALSE
)

Arguments

irr_mel

Numeric vector. Melanopic irradiance values.

lux

Numeric vector. Photopic illuminance values.

sampling_int

Numeric. Sampling interval in seconds.

datetime

POSIXct vector. Datetime values. Will only be used if sleep_onset is specified. Default is NULL.

sleep_onset

Character. Time of habitual sleep onset in the format "HH:MM:SS". Will only be used if datetime is specified. Default is NULL.

shiftModel

Logical. Should the spectral shift model be used? Default is FALSE.

Details

If datetime and sleep_onset are not specified, the start of the timeseries is assumed to be at habitual sleep onset. The timeseries is assumed to be regular. Missing values in the light data will be replaced by 0.

Value

Numeric vector with circadian response values.

References

Amundadottir, M.L. (2016). Light-driven model for identifying indicators of non-visual health potential in the built environment. [Doctoral dissertation, EPFL]. EPFL infoscience. http://dx.doi.org/10.5075/epfl-thesis-7146


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