From 23b0700353f79de41d77af20005bf196d45d5a09 Mon Sep 17 00:00:00 2001 From: shawn schwartz <s@shawnts.com> Date: Mon, 25 Nov 2024 00:02:47 -0800 Subject: [PATCH] feature #90: update text clarity within documentation for new interactive epoching feature --- R/bidsify.R | 10 +++++----- man/bidsify.Rd | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/R/bidsify.R b/R/bidsify.R index 33f3f3a..7fee484 100644 --- a/R/bidsify.R +++ b/R/bidsify.R @@ -32,11 +32,11 @@ #' @param report_seed Random seed for the plots that will appear in the report. #' Defaults to 0. See [eyeris::plot()] for a more detailed description. #' @param report_epoch_grouping_var_col String name of grouping column to use -#' for epoch-by-epoch diagnostic plots in the rendered report. Column name must -#' exist (i.e., be a custom grouping variable name set within the metadata -#' template of your `epoch()` call). Defaults to `"matched_event"`, which all -#' epoched dataframes have as a valid column name. To disable these epoch-level -#' diagnostic plots, set to `NULL`. +#' for epoch-by-epoch diagnostic plots in an interactive rendered HTML report. +#' Column name must exist (i.e., be a custom grouping variable name set within +#' the metadata template of your `epoch()` call). Defaults to `"matched_event"`, +#' which all epoched dataframes have as a valid column name. To disable these +#' epoch-level diagnostic plots, set to `NULL`. #' #' @examples #' # Bleed around blink periods just long enough to remove majority of diff --git a/man/bidsify.Rd b/man/bidsify.Rd index 32f1adf..02b29c0 100644 --- a/man/bidsify.Rd +++ b/man/bidsify.Rd @@ -56,11 +56,11 @@ must already be installed. Defaults to FALSE.} Defaults to 0. See \code{\link[=plot]{plot()}} for a more detailed description.} \item{report_epoch_grouping_var_col}{String name of grouping column to use -for epoch-by-epoch diagnostic plots in the rendered report. Column name must -exist (i.e., be a custom grouping variable name set within the metadata -template of your \code{epoch()} call). Defaults to \code{"matched_event"}, which all -epoched dataframes have as a valid column name. To disable these epoch-level -diagnostic plots, set to \code{NULL}.} +for epoch-by-epoch diagnostic plots in an interactive rendered HTML report. +Column name must exist (i.e., be a custom grouping variable name set within +the metadata template of your \code{epoch()} call). Defaults to \code{"matched_event"}, +which all epoched dataframes have as a valid column name. To disable these +epoch-level diagnostic plots, set to \code{NULL}.} } \description{ This method provides a structured way to save out pupil data in a BIDS-like