add details about loops to vignette and help file of manage frame gaps

R/plotting_functions.R

@@ -11,11 +11,13 @@
 #'
 #' @param obj_name The input viewr object; a tibble or data.frame with attribute
 #'   \code{pathviewR_steps} that includes \code{"viewr"}
-#' @param loops How many total frame gap entries to consider
+#' @param loops How many total frame gap entries to consider. Each loop will
+#'   increase the \code{max_fram_gap} argument in \code{separate_trajectories}
+#'   by 1.
 #' @param ... Additional arguments
 #'
 #' @details The input viewr object (\code{obj_name}) should likely be an object
-#' that has passed through the \code{select_x_percent()} step.
+#'   that has passed through the \code{select_x_percent()} step.
 #'
 #' @return A plot and a tibble, each of which shows the total number of
 #'   trajectories that result from using the specified range of

example_scripts/ropensci_reviews_checklist.md

@@ -118,8 +118,7 @@ it be relevant to allow the autodetect approach to be applied to each subject
 separately? (or maybe that is not relevant...)
 
 Items for us:  
-- [ ] do we not already do this? Let's look into it. If we already do, let's
-see if we can make it clearer in the vignette.
+- [ ] we already do this. add example in the vignette
 
 #### Visual perception 
 

vignettes/managing-frame-gaps.Rmd

@@ -150,7 +150,10 @@ plot_viewr_trajectories(motive_mfg5_full,
 be appropriate depending on their data and resolution needs.
 `visualize_frame_gap_choice()` runs the `separate_trajectories()` function over
 the same data set as many times as the user would like via the `loop` argument,
-each time with a different `max_frame_gap` allowance.
+each time with a different `max_frame_gap` allowance. Each loop represents an
+increase in the max frame gap value of 1. For example the default of `loops =
+20` will run `separate_trajectories()` over the data set 20 times, with an
+increase in the `max_frame_gap` argument of 1 each time.
 
 ```{r visualize_frame_gap_choice}
 motive_cleaned %>%