Change state_prop() default value for state_values to include both sleeping and resting states

Author: danielvartan

NEWS.md

@@ -4,6 +4,7 @@
 - `sri()` now `min_data` as an argument, which specifies the minimum proportion of non-missing values required to compute the SRI for each time point. If the proportion of non-missing values is below this threshold, the SRI will be set to `NA` for that time point. This helps to avoid computing the SRI when there is insufficient data.
 - `sri()` now returns a `valid_data` column, which indicates the proportion of non-missing values in the `agreement` column for each time point. This provides additional information about the data quality used to compute the SRI.
 - `sri()` now has different default values for `sleeping_states` and `awake_states`. The new defaults are `sleeping_states = c(1, 2)` and `awake_states = 0`. The previous defaults were `sleeping_states = 1` and `awake_states = c(0, 2)`, which considered *resting* states as awake, differing from the way that the index was originally computed.
+- `state_prop()` now has a default value of `c(1, 2)` for `state_values`, which considers both *sleeping* and *resting* states (for Condor Instruments actigraphy data) as the target states for calculating the proportion. The previous default was `1`, which only considered the *sleeping* state.
 
 # actverse 0.1.0
 

R/state_prop.R

@@ -13,7 +13,7 @@
 #' @param state_values (optional) An
 #'   [`integerish`][checkmate::assert_integerish] vector indicating which state
 #'   values are considered as the target state(s) for calculating the proportion
-#'   (default: `1`).
+#'   (default: `c(1, 2)`).
 #'
 #' @return A [`tsibble`][tsibble::tsibble()] object with the following columns:
 #'
@@ -42,7 +42,7 @@
 #'   )
 #'
 #'   data <- read_acttrust(file, tz = "America/Sao_Paulo")
-#'   state_prop_data <- data |> state_prop(state_values = 1) # Sleeping state
+#'   state_prop_data <- data |> state_prop() # Sleeping + Resting states
 #'
 #'   state_prop_data |> print()
 #'
@@ -75,7 +75,7 @@
 state_prop <- function(
   data,
   state_col = "state",
-  state_values = 1
+  state_values = c(1, 2)
 ) {
   assert_tsibble(data)
   assert_regularity(data, strict = TRUE)