nvR_circadian_metrics: Performance metrics for circadian response
In steffenhartmeyer/lightdosimetry: Functions for quantifying personal light exposure data
nvR_circadian_metrics R Documentation
Performance metrics for circadian response
Description
Performance metrics for circadian response
Usage
nvR_circadianDisturbance(RC, RC_ref, as_df = TRUE)
nvR_circadianBias(RC, RC_ref, as_df = TRUE)
nvR_relativeAmplitudeError(RC, RC_ref, as_df = TRUE)
Arguments
RC
Time series of circadian response (see circadianResponse.
Length must be 24h.
RC_ref
Time series of circadian response (see circadianResponse
for reference light exposure pattern. Length must be 24h.
as_df
Logical. Should the output be returned as a data frame? Defaults
to TRUE.
Details
'nvR_circadianDisturbance()' calculates the circadian disturbance (CD).
'nvR_circadianBias()' calculates the circadian bias (CB).
'nvR_relativeAmplitudeError()' calculates the relative amplitude error (RAE).
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.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| nvR_circadian_metrics | R Documentation |
Performance metrics for circadian response
Description
Performance metrics for circadian response
Usage
nvR_circadianDisturbance(RC, RC_ref, as_df = TRUE)
nvR_circadianBias(RC, RC_ref, as_df = TRUE)
nvR_relativeAmplitudeError(RC, RC_ref, as_df = TRUE)
Arguments
RC |
Time series of circadian response (see |
RC_ref |
Time series of circadian response (see |
as_df |
Logical. Should the output be returned as a data frame? Defaults to TRUE. |
Details
'nvR_circadianDisturbance()' calculates the circadian disturbance (CD).
'nvR_circadianBias()' calculates the circadian bias (CB).
'nvR_relativeAmplitudeError()' calculates the relative amplitude error (RAE).
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
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.