so | R Documentation |
so()
computes the local time of sleep onset for standard and shift
versions of the Munich ChronoType Questionnaire (MCTQ).
Note that this value is collected directly from the questionnaire if you're
using the \mu
MCTQ.
so(sprep, slat)
sprep |
An |
slat |
A |
Standard MCTQ functions were created following the guidelines in Roenneberg, Wirz-Justice, & Merrow (2003), Roenneberg, Allebrandt, Merrow, & Vetter (2012), and from The Worldwide Experimental Platform (theWeP, n.d.).
\mu
MCTQ functions were created following the guidelines in Ghotbi
et al. (2020), in addition to the guidelines used for the standard MCTQ.
MCTQ^{Shift}
functions were created following the
guidelines in Juda, Vetter, & Roenneberg (2013), in addition to the
guidelines used for the standard MCTQ.
See the References section to learn more.
The mctq
package works with a set of object classes specially created to
hold time values. These classes can be found in the
lubridate and hms
packages. Please refer to those package documentations to learn more about
them.
Some operations may produce an output with fractional time (e.g.,
"19538.3828571429s (~5.43 hours)"
, 01:15:44.505
). If you want, you
can round it with mctq:::round_time()
.
Our recommendation is to avoid rounding, but, if you do, make sure that you only round your values after all computations are done. That way you avoid round-off errors.
An hms
object corresponding to the vectorized sum of
sprep
and slat
in a circular time frame of 24 hours.
Roenneberg, Allebrandt, Merrow, & Vetter (2012), Juda, Vetter, & Roenneberg
(2013), and The Worldwide Experimental Platform (n.d.) guidelines for so()
(SO
) computation are as follows.
This computation must be applied to each section of the questionnaire.
If you are visualizing this documentation in plain text, you may have some trouble understanding the equations. You can see this documentation on the package website.
SO_{W/F} = SPrep_{W/F} + SLat_{W/F}
Where:
SO_{W/F}
= Local time of sleep onset on work or work-free days.
SPrep_{W/F}
= Local time of preparing to sleep on work or
work-free days ("I actually get ready to fall asleep at ___ o'clock").
SLat_{W/F}
= Sleep latency or time to fall asleep after preparing to
sleep on work or work-free days ("I need ___ min to fall asleep").
* W
= Workdays; F
= Work-free days.
SO_{W/F}^{M/E/N} = SPrep_{W/F}^{M/E/N} + SLat_{W/F}^{M/E/N}
Where:
SO_{W/F}^{M/E/N}
= Local time of sleep onset between two days in a
particular shift or between two free days after a particular shift.
SPrep_{W/F}^{M/E/N}
= Local time of preparing to sleep between two
days in a particular shift or between two free days after a particular
shift ("I actually get ready to fall asleep at ___ o'clock").
SLat_{W/F}^{M/E/N}
= Sleep latency or time to fall asleep after
preparing to sleep between two days in a particular shift or between two
free days after a particular shift ("I need ___ min to fall asleep").
* W
= Workdays; F
= Work-free days, M
=
Morning shift; E
= Evening shift; N
= Night shift.
Ghotbi, N., Pilz, L. K., Winnebeck, E. C., Vetter, C., Zerbini, G., Lenssen,
D., Frighetto, G., Salamanca, M., Costa, R., Montagnese, S., & Roenneberg, T.
(2020). The \mu
MCTQ: an ultra-short version of the Munich ChronoType
Questionnaire. Journal of Biological Rhythms, 35(1), 98-110.
\Sexpr[results=rd]{tools:::Rd_expr_doi("10.1177/0748730419886986")}
Juda, M., Vetter, C., & Roenneberg, T. (2013). The Munich ChronoType
Questionnaire for shift-workers (MCTQ^{Shift}
). Journal of
Biological Rhythms, 28(2), 130-140. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1177/0748730412475041")}
Roenneberg T., Allebrandt K. V., Merrow M., & Vetter C. (2012). Social jetlag and obesity. Current Biology, 22(10), 939-43. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1016/j.cub.2012.03.038")}
Roenneberg, T., Wirz-Justice, A., & Merrow, M. (2003). Life between clocks: daily temporal patterns of human chronotypes. Journal of Biological Rhythms, 18(1), 80-90. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1177/0748730402239679")}
The Worldwide Experimental Platform (n.d.). MCTQ. https://www.thewep.org/documentations/mctq/
Other MCTQ functions:
fd()
,
gu()
,
le_week()
,
msf_sc()
,
msl()
,
napd()
,
sd24()
,
sd_overall()
,
sd_week()
,
sdu()
,
sjl()
,
sjl_sc()
,
sjl_weighted()
,
tbt()
## Scalar example
sprep <- hms::parse_hm("22:00")
slat <- lubridate::dminutes(15)
so(sprep, slat)
#> 22:15:00 # Expected
sprep <- hms::parse_hm("23:30")
slat <- lubridate::dminutes(45)
so(sprep, slat)
#> 00:15:00 # Expected
sprep <- hms::parse_hm("20:45")
slat <- lubridate::as.duration(NA)
so(sprep, slat)
#> NA # Expected
## Vector example
sprep <- c(hms::parse_hm("21:30"), hms::parse_hm("22:15"))
slat <- c(lubridate::dminutes(45), lubridate::dminutes(5))
so(sprep, slat)
#> 22:15:00 # Expected
#> 22:20:00 # Expected
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.