improve comments and examples

Author: pydemull

R/mark_intensity.R

@@ -150,7 +150,8 @@ mark_intensity <- function(data,
         df$bout <- cumsum(c(1, as.numeric(diff(df$intensity_category_num))!= 0))
 
 
-  # Setting count-based data and related data to NA for abnormal metric if required
+  # Setting count-based variables and related variables to NA when Axis 1 data are abnormal
+  # Detected abnormal epochs will considered as "nonwear"
 
   if (ehcv != "none" & is.numeric(ehcv) & ehcv >= 0) {
 

R/recap_by_day.R

@@ -105,7 +105,8 @@
 #'     vpa_cutpoint = 6167, 
 #'     age = 32,
 #'     weight = 67,
-#'     sex = "male"
+#'     sex = "male",
+#'     ehcv = 15000
 #'     )
 #' recap_by_day(
 #'     data = mydata_with_intensity_marks, 
@@ -117,7 +118,8 @@
 #'     valid_wear_time_end = "22:00:00",
 #'     start_first_bin = 0,
 #'     start_last_bin = 10000,
-#'     bin_width = 500
+#'     bin_width = 500,
+#'     ehcv = 15000
 #'     )
 #' }
 #'