expect no or at least two values for parameter clevels #653

wadpac · Aug 7, 2024 · ff883c2 · ff883c2
1 parent 5defbcb
commit ff883c2
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/R/check_params.R b/R/check_params.R
@@ -347,6 +347,9 @@ check_params = function(params_sleep = c(), params_metrics = c(),
       params_output[["save_ms5rawlevels"]] = TRUE
       params_output[["save_ms5raw_without_invalid"]] = FALSE
     }
+    if (length(params_247[["clevels"]]) == 1) {
+      warning("\nParameter clevels expects a number vector of at least 2 values, current length is 1", call. = FALSE)
+    }
   }
   if (!is.null(params_general[["expand_tail_max_hours"]])) {
     if (is.null(params_general[["recordingEndSleepHour"]]) & params_general[["expand_tail_max_hours"]] != 0) {

diff --git a/R/g.part5_analyseSegment.R b/R/g.part5_analyseSegment.R
@@ -230,7 +230,7 @@ g.part5_analyseSegment = function(indexlog, timeList, levelList,
     #======================================================
     # STEPS... (IF STEP_COUNT IS AVAILABLE)
     if ("step_count" %in% names(ts)) {
-      if (length(params_247[["clevels"]]) > 0) {
+      if (length(params_247[["clevels"]]) > 1) {
         for (windowhalf in c("day", "spt")) {
           step_subsegment = sse[ts$diur[sse] == ifelse(windowhalf == "day", yes = 0, no = 1)]
           cadence = ts$step_count[step_subsegment] / (60 / ws3new)

diff --git a/man/GGIR.Rd b/man/GGIR.Rd
@@ -1399,8 +1399,9 @@ GGIR(mode = 1:5,
         onset till the 10th wakeup time.
       }
       \item{clevel}{
-        Numeric vector (default = c(30, 150)) to indicate cadence ranges used 
-        when summarising step counts, if available.
+        Numeric vector (default = c(30, 150)) with length 2 to indicate cadence ranges used 
+        when summarising step counts, if available. When set to NULL, step counts will not be
+        summarised in part 5 output.
       }
     }
   }