docs: update documentation

R/workpatterns_classify.R

@@ -57,7 +57,13 @@
 #'   - **5 Always on (13h+)**: number of active hours greater than or equal to
 #'   13
 #'
-#'   This is the recommended method over `pav` for several reasons:
+#'  _Standard_ here denotes the behaviour of not exhibiting total number of
+#'  active hours which exceed the expected total number of hours, as supplied by
+#'  `exp_hours`. _Continuous_ refers to the behaviour of _not_ taking breaks,
+#'  i.e. no inactive hours between the first and last active hours of the day,
+#'  where _flexible_ refers to the contrary.
+#'
+#'  This is the recommended method over `pav` for several reasons:
 #'   1. `bw` ignores _volume effects_, where activity volume can still bias the
 #'   results towards the 'standard working hours'.
 #'   2. It captures the intuition that each individual can have 'light' and
@@ -73,11 +79,11 @@
 #' In the standard plot output, the archetypes have been abbreviated to show the
 #' following:
 #'   - **Low Activity** - archetype 0
-#'   - **Standard** - archetype 2
-#'   - **Flexible** - archetypes 1 and 3
-#'   - **Long continuous** - archetype 5
-#'   - **Long flexible** - archetype 4
-#'   - **Always On** - archetype 6
+#'   - **Standard** - archetypes 1.1 and 1.2
+#'   - **Flexible** - archetypes 2.1 and 2.2
+#'   - **Long continuous** - archetype 4
+#'   - **Long flexible** - archetype 3
+#'   - **Always On** - archetype 5
 #'
 #' @section Person Average method:
 #'

man/workpatterns_classify.Rd

@@ -152,6 +152,12 @@ hours}, with activity happening in a continuous block (no breaks)
 13
 }
 
+\emph{Standard} here denotes the behaviour of not exhibiting total number of
+active hours which exceed the expected total number of hours, as supplied by
+\code{exp_hours}. \emph{Continuous} refers to the behaviour of \emph{not} taking breaks,
+i.e. no inactive hours between the first and last active hours of the day,
+where \emph{flexible} refers to the contrary.
+
 This is the recommended method over \code{pav} for several reasons:
 \enumerate{
 \item \code{bw} ignores \emph{volume effects}, where activity volume can still bias the
@@ -171,11 +177,11 @@ In the standard plot output, the archetypes have been abbreviated to show the
 following:
 \itemize{
 \item \strong{Low Activity} - archetype 0
-\item \strong{Standard} - archetype 2
-\item \strong{Flexible} - archetypes 1 and 3
-\item \strong{Long continuous} - archetype 5
-\item \strong{Long flexible} - archetype 4
-\item \strong{Always On} - archetype 6
+\item \strong{Standard} - archetypes 1.1 and 1.2
+\item \strong{Flexible} - archetypes 2.1 and 2.2
+\item \strong{Long continuous} - archetype 4
+\item \strong{Long flexible} - archetype 3
+\item \strong{Always On} - archetype 5
 }
 }