From 5c2d496e00434f02b2b934c3ecbc48181fd6b81d Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 5 Mar 2024 18:53:48 +0530 Subject: [PATCH 1/8] standardise the option notation. --- R/call_utils.R | 10 +++++----- R/choices_selected.R | 2 +- R/filter_spec.R | 4 ++-- R/get_dplyr_call.R | 2 +- R/get_merge_call.R | 4 ++-- R/select_spec.R | 8 ++++---- R/utils.R | 2 +- man/call_extract_array.Rd | 6 +++--- man/call_extract_matrix.Rd | 4 ++-- man/choices_selected.Rd | 2 +- man/extract_choices_labels.Rd | 2 +- man/filter_spec.Rd | 4 ++-- man/filter_spec_internal.Rd | 4 ++-- man/get_dplyr_call.Rd | 2 +- man/get_merge_key_i.Rd | 2 +- man/get_rename_call.Rd | 2 +- man/get_reshape_call.Rd | 2 +- man/parse_merge_key_i.Rd | 2 +- man/select_spec.Rd | 8 ++++---- 19 files changed, 36 insertions(+), 36 deletions(-) diff --git a/R/call_utils.R b/R/call_utils.R index deb23d52..436e05cb 100644 --- a/R/call_utils.R +++ b/R/call_utils.R @@ -201,11 +201,11 @@ call_condition_range_date <- function(varname, range) { #' Get call to subset and select array #' #' @param dataname (`character(1)` or `name`). -#' @param row (optional `name` or `call` or `logical` or `integer` or `character`) +#' @param row (`name` or `call` or `logical` or `integer` or `character`) optional, #' name of the `row` or condition. -#' @param column (optional `name` or `call` or `logical`, `integer` or `character`) +#' @param column (`name` or `call` or `logical` or `integer` or `character`) optional, #' name of the `column` or condition. -#' @param aisle (optional `name` or `call` or `logical` or `integer` or `character`) +#' @param aisle (`name` or `call` or `logical` or `integer` or `character`) optional, #' name of the `row` or condition. #' #' @return [Extract()] `call` for 3-dimensional array in `x[i, j, k]` notation. @@ -251,9 +251,9 @@ call_extract_array <- function(dataname = ".", row = NULL, column = NULL, aisle #' Get call to subset and select matrix #' #' @param dataname (`character(1)` or `name`). -#' @param row (optional `name` or `call` or `logical` or `integer` or `character`) +#' @param row (`name` or `call` or `logical` or `integer` or `character`) optional, #' name of the `row` or condition. -#' @param column (optional `name` or `call` or `logical` or `integer` or `character`) +#' @param column (`name` or `call` or `logical` or `integer` or `character`) optional, #' name of the `column` or condition. #' #' @return [Extract()] `call` for matrix in `x[i, j]` notation. diff --git a/R/choices_selected.R b/R/choices_selected.R index a453948a..2f7e31d0 100644 --- a/R/choices_selected.R +++ b/R/choices_selected.R @@ -32,7 +32,7 @@ no_select_keyword <- "-- no selection --" #' `choices` is a vector, or `NULL` if `choices` is a `delayed_data` object. #' @param keep_order (`logical`) In case of `FALSE` the selected variables will #' be on top of the drop-down field. -#' @param fixed (optional `logical`) Whether to block user to select choices. +#' @param fixed (`logical`) optional, whether to block user to select choices. #' #' @return `choices_selected` returns list of `choices_selected`, encapsulating the specified #' `choices`, `selected`, `keep_order` and `fixed`. diff --git a/R/filter_spec.R b/R/filter_spec.R index 6fa8488d..da118efd 100644 --- a/R/filter_spec.R +++ b/R/filter_spec.R @@ -41,9 +41,9 @@ #' (default values). #' This value will be displayed inside the shiny app upon start. #' The `all_choices` object indicates selecting all possible choices. -#' @param drop_keys (optional `logical`) whether to drop filter column from the +#' @param drop_keys (`logical`) optional, whether to drop filter column from the #' dataset keys, `TRUE` on default. -#' @param label (optional `character`). Define a label on top of this specific +#' @param label (`character`) optional, define a label on top of this specific #' shiny [shiny::selectInput()]. The default value is `"Filter by"`. #' #' @return `filter_spec`-S3-class object or `delayed_filter_spec`-S3-class object. diff --git a/R/get_dplyr_call.R b/R/get_dplyr_call.R index c443eba9..e25b47b3 100644 --- a/R/get_dplyr_call.R +++ b/R/get_dplyr_call.R @@ -123,7 +123,7 @@ get_dplyr_call_data <- function(selector_list, join_keys = teal.data::join_keys( #' #' @inheritParams get_dplyr_call_data #' -#' @param idx optional (`integer`) current selector index in all selectors list. +#' @param idx (`integer`) optional, current selector index in all selectors list. #' @param dplyr_call_data (`list`) simplified selectors with aggregated set of filters, #' selections, reshapes etc. All necessary data for merging. #' @param data (`NULL` or named `list`) of datasets. diff --git a/R/get_merge_call.R b/R/get_merge_call.R index 54a89b90..10c9d004 100644 --- a/R/get_merge_call.R +++ b/R/get_merge_call.R @@ -202,7 +202,7 @@ get_merge_key_pair <- function(selector_from, selector_to, key_from) { #' Gets keys needed for join call of two selectors #' #' @inheritParams get_merge_call -#' @param idx (optional `integer`) current selector index in all selectors list. +#' @param idx (`integer`) optional, current selector index in all selectors list. #' #' @return `character` list of keys. #' @@ -294,7 +294,7 @@ get_merge_key_i <- function(selector_list, idx, dplyr_call_data = get_dplyr_call #' #' @inheritParams get_merge_call #' @param merge_key keys obtained from `get_merge_key_i`. -#' @param idx optional (`integer`) current selector index in all selectors list. +#' @param idx (`integer`) optional, current selector index in all selectors list. #' #' @return `call` with merge keys. #' diff --git a/R/select_spec.R b/R/select_spec.R index 02f05af5..da2bc2cc 100644 --- a/R/select_spec.R +++ b/R/select_spec.R @@ -13,20 +13,20 @@ #' These have to be columns in the dataset defined in the [data_extract_spec()] #' where this is called. #' `delayed_data` objects can be created via [variable_choices()] or [value_choices()]. -#' @param selected (optional `character` or `NULL` or `all_choices` or `delayed_data`). -#' Named character vector to define the selected values of a shiny [shiny::selectInput()]. +#' @param selected (`character` or `NULL` or `all_choices` or `delayed_data`) optional, +#' named character vector to define the selected values of a shiny [shiny::selectInput()]. #' Passing an `all_choices()` object indicates selecting all possible choices. #' Defaults to the first value of `choices` or `NULL` for delayed data loading. #' @param multiple (`logical`) Whether multiple values shall be allowed in the #' shiny [shiny::selectInput()]. -#' @param fixed (optional `logical`). [data_extract_spec()] specific feature to +#' @param fixed (`logical`) optional, [data_extract_spec()] specific feature to #' hide the choices selected in case they are not needed. Setting fixed to `TRUE` #' will not allow the user to select columns. It will then lead to a selection of #' columns in the dataset that is defined by the developer of the app. #' @param always_selected (`character`) Additional column names from the data set that should #' always be selected #' @param ordered (`logical(1)`) Flags whether selection order should be tracked. -#' @param label (optional `character`). Define a label on top of this specific +#' @param label (`character`) optional, define a label on top of this specific #' shiny [shiny::selectInput()]. The default value is `"Select"`. #' #' @return A `select_spec`-S3 class object or `delayed_select_spec`-S3-class object. diff --git a/R/utils.R b/R/utils.R index 620bfe3e..f7693246 100644 --- a/R/utils.R +++ b/R/utils.R @@ -22,7 +22,7 @@ split_by_sep <- function(x, sep) { #' Extract labels from choices basing on attributes and names #' #' @param choices (`list` or `vector`) select choices. -#' @param values (optional `list` or `vector`) with subset of `choices` for which +#' @param values (`list` or `vector`) optional, with subset of `choices` for which #' labels should be extracted, `NULL` for all choices. #' #' @return `character` vector with labels. diff --git a/man/call_extract_array.Rd b/man/call_extract_array.Rd index fed7d671..3b4a50ae 100644 --- a/man/call_extract_array.Rd +++ b/man/call_extract_array.Rd @@ -9,13 +9,13 @@ call_extract_array(dataname = ".", row = NULL, column = NULL, aisle = NULL) \arguments{ \item{dataname}{(\code{character(1)} or \code{name}).} -\item{row}{(optional \code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) +\item{row}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional, name of the \code{row} or condition.} -\item{column}{(optional \code{name} or \code{call} or \code{logical}, \code{integer} or \code{character}) +\item{column}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional, name of the \code{column} or condition.} -\item{aisle}{(optional \code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) +\item{aisle}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional, name of the \code{row} or condition.} } \value{ diff --git a/man/call_extract_matrix.Rd b/man/call_extract_matrix.Rd index 35aef9fb..90e49eaa 100644 --- a/man/call_extract_matrix.Rd +++ b/man/call_extract_matrix.Rd @@ -9,10 +9,10 @@ call_extract_matrix(dataname = ".", row = NULL, column = NULL) \arguments{ \item{dataname}{(\code{character(1)} or \code{name}).} -\item{row}{(optional \code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) +\item{row}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional, name of the \code{row} or condition.} -\item{column}{(optional \code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) +\item{column}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional, name of the \code{column} or condition.} } \value{ diff --git a/man/choices_selected.Rd b/man/choices_selected.Rd index 33682b8a..e1f43164 100644 --- a/man/choices_selected.Rd +++ b/man/choices_selected.Rd @@ -29,7 +29,7 @@ If not supplied it will default to the first element of \code{choices} if \item{keep_order}{(\code{logical}) In case of \code{FALSE} the selected variables will be on top of the drop-down field.} -\item{fixed}{(optional \code{logical}) Whether to block user to select choices.} +\item{fixed}{(\code{logical}) optional, whether to block user to select choices.} \item{x}{(\code{choices_selected}) object to check.} } diff --git a/man/extract_choices_labels.Rd b/man/extract_choices_labels.Rd index 972cf19f..1187ed56 100644 --- a/man/extract_choices_labels.Rd +++ b/man/extract_choices_labels.Rd @@ -9,7 +9,7 @@ extract_choices_labels(choices, values = NULL) \arguments{ \item{choices}{(\code{list} or \code{vector}) select choices.} -\item{values}{(optional \code{list} or \code{vector}) with subset of \code{choices} for which +\item{values}{(\code{list} or \code{vector}) optional, with subset of \code{choices} for which labels should be extracted, \code{NULL} for all choices.} } \value{ diff --git a/man/filter_spec.Rd b/man/filter_spec.Rd index 19402cc6..2d2c1423 100644 --- a/man/filter_spec.Rd +++ b/man/filter_spec.Rd @@ -46,13 +46,13 @@ The \code{all_choices} object indicates selecting all possible choices.} \item{multiple}{(\code{logical}) Whether multiple values shall be allowed in the shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}.} -\item{label}{(optional \code{character}). Define a label on top of this specific +\item{label}{(\code{character}) optional, define a label on top of this specific shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}. The default value is \code{"Filter by"}.} \item{sep}{(\code{character}) A separator string to split the \code{choices} or \code{selected} inputs into the values of the different columns.} -\item{drop_keys}{(optional \code{logical}) whether to drop filter column from the +\item{drop_keys}{(\code{logical}) optional, whether to drop filter column from the dataset keys, \code{TRUE} on default.} } \value{ diff --git a/man/filter_spec_internal.Rd b/man/filter_spec_internal.Rd index 09e38b11..ca16aa86 100644 --- a/man/filter_spec_internal.Rd +++ b/man/filter_spec_internal.Rd @@ -96,7 +96,7 @@ Named character vector to define the selected values of a shiny \code{\link[shin This value will be displayed inside the shiny app upon start. The \code{all_choices} object indicates selecting all possible choices.} -\item{label}{(optional \code{character}). Define a label on top of this specific +\item{label}{(\code{character}) optional, define a label on top of this specific shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}. The default value is \code{"Filter by"}.} \item{fixed}{(\code{logical}) @@ -108,7 +108,7 @@ shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}.} \item{sep}{(\code{character}) A separator string to split the \code{choices} or \code{selected} inputs into the values of the different columns.} -\item{drop_keys}{(optional \code{logical}) whether to drop filter column from the +\item{drop_keys}{(\code{logical}) optional, whether to drop filter column from the dataset keys, \code{TRUE} on default.} \item{dataname}{(\code{character}) diff --git a/man/get_dplyr_call.Rd b/man/get_dplyr_call.Rd index 056eeabe..2e90276c 100644 --- a/man/get_dplyr_call.Rd +++ b/man/get_dplyr_call.Rd @@ -20,7 +20,7 @@ When using a reactive named list, the names must be identical to the shiny ids of the respective \code{\link[=data_extract_ui]{data_extract_ui()}}.} -\item{idx}{optional (\code{integer}) current selector index in all selectors list.} +\item{idx}{(\code{integer}) optional, current selector index in all selectors list.} \item{join_keys}{(\code{join_keys}) nested list of keys used for joining.} diff --git a/man/get_merge_key_i.Rd b/man/get_merge_key_i.Rd index 7705272e..ad776260 100644 --- a/man/get_merge_key_i.Rd +++ b/man/get_merge_key_i.Rd @@ -18,7 +18,7 @@ When using a reactive named list, the names must be identical to the shiny ids of the respective \code{\link[=data_extract_ui]{data_extract_ui()}}.} -\item{idx}{(optional \code{integer}) current selector index in all selectors list.} +\item{idx}{(\code{integer}) optional, current selector index in all selectors list.} \item{dplyr_call_data}{(\code{list}) simplified selectors with aggregated set of filters.} } diff --git a/man/get_rename_call.Rd b/man/get_rename_call.Rd index d6e12628..92980ea3 100644 --- a/man/get_rename_call.Rd +++ b/man/get_rename_call.Rd @@ -19,7 +19,7 @@ When using a reactive named list, the names must be identical to the shiny ids of the respective \code{\link[=data_extract_ui]{data_extract_ui()}}.} -\item{idx}{optional (\code{integer}) current selector index in all selectors list.} +\item{idx}{(\code{integer}) optional, current selector index in all selectors list.} \item{join_keys}{(\code{join_keys}) nested list of keys used for joining.} diff --git a/man/get_reshape_call.Rd b/man/get_reshape_call.Rd index b4149970..95a0aba1 100644 --- a/man/get_reshape_call.Rd +++ b/man/get_reshape_call.Rd @@ -19,7 +19,7 @@ When using a reactive named list, the names must be identical to the shiny ids of the respective \code{\link[=data_extract_ui]{data_extract_ui()}}.} -\item{idx}{optional (\code{integer}) current selector index in all selectors list.} +\item{idx}{(\code{integer}) optional, current selector index in all selectors list.} \item{join_keys}{(\code{join_keys}) nested list of keys used for joining.} diff --git a/man/parse_merge_key_i.Rd b/man/parse_merge_key_i.Rd index d97c552e..3f709795 100644 --- a/man/parse_merge_key_i.Rd +++ b/man/parse_merge_key_i.Rd @@ -19,7 +19,7 @@ When using a reactive named list, the names must be identical to the shiny ids of the respective \code{\link[=data_extract_ui]{data_extract_ui()}}.} -\item{idx}{optional (\code{integer}) current selector index in all selectors list.} +\item{idx}{(\code{integer}) optional, current selector index in all selectors list.} \item{dplyr_call_data}{(\code{list}) simplified selectors with aggregated set of filters.} diff --git a/man/select_spec.Rd b/man/select_spec.Rd index 888e063f..934bcff3 100644 --- a/man/select_spec.Rd +++ b/man/select_spec.Rd @@ -43,15 +43,15 @@ These have to be columns in the dataset defined in the \code{\link[=data_extract where this is called. \code{delayed_data} objects can be created via \code{\link[=variable_choices]{variable_choices()}} or \code{\link[=value_choices]{value_choices()}}.} -\item{selected}{(optional \code{character} or \code{NULL} or \code{all_choices} or \code{delayed_data}). -Named character vector to define the selected values of a shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}. +\item{selected}{(\code{character} or \code{NULL} or \code{all_choices} or \code{delayed_data}) optional, +named character vector to define the selected values of a shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}. Passing an \code{all_choices()} object indicates selecting all possible choices. Defaults to the first value of \code{choices} or \code{NULL} for delayed data loading.} \item{multiple}{(\code{logical}) Whether multiple values shall be allowed in the shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}.} -\item{fixed}{(optional \code{logical}). \code{\link[=data_extract_spec]{data_extract_spec()}} specific feature to +\item{fixed}{(\code{logical}) optional, \code{\link[=data_extract_spec]{data_extract_spec()}} specific feature to hide the choices selected in case they are not needed. Setting fixed to \code{TRUE} will not allow the user to select columns. It will then lead to a selection of columns in the dataset that is defined by the developer of the app.} @@ -61,7 +61,7 @@ always be selected} \item{ordered}{(\code{logical(1)}) Flags whether selection order should be tracked.} -\item{label}{(optional \code{character}). Define a label on top of this specific +\item{label}{(\code{character}) optional, define a label on top of this specific shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}. The default value is \code{"Select"}.} } \value{ From 6896d3cc8b23c58dc49672a7672b3b2496c1e0d5 Mon Sep 17 00:00:00 2001 From: kartikeyakirar Date: Tue, 5 Mar 2024 19:55:22 +0530 Subject: [PATCH 2/8] 'trigger' From 1c5a9b410dce82bc8ac36a468df458e1d03e34c8 Mon Sep 17 00:00:00 2001 From: kartikeya kirar Date: Thu, 14 Mar 2024 17:55:03 +0530 Subject: [PATCH 3/8] Update R/select_spec.R Co-authored-by: Marcin <133694481+m7pr@users.noreply.github.com> Signed-off-by: kartikeya kirar --- R/select_spec.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/select_spec.R b/R/select_spec.R index da2bc2cc..719f3b8a 100644 --- a/R/select_spec.R +++ b/R/select_spec.R @@ -26,7 +26,7 @@ #' @param always_selected (`character`) Additional column names from the data set that should #' always be selected #' @param ordered (`logical(1)`) Flags whether selection order should be tracked. -#' @param label (`character`) optional, define a label on top of this specific +#' @param label (`character`) optional, defines a label on top of this specific #' shiny [shiny::selectInput()]. The default value is `"Select"`. #' #' @return A `select_spec`-S3 class object or `delayed_select_spec`-S3-class object. From 0f892979a9f0bbf38d9e79881288ce4a8b4be2c7 Mon Sep 17 00:00:00 2001 From: kartikeya kirar Date: Thu, 14 Mar 2024 17:55:13 +0530 Subject: [PATCH 4/8] Update R/call_utils.R Co-authored-by: Marcin <133694481+m7pr@users.noreply.github.com> Signed-off-by: kartikeya kirar --- R/call_utils.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/call_utils.R b/R/call_utils.R index 436e05cb..33b14680 100644 --- a/R/call_utils.R +++ b/R/call_utils.R @@ -201,7 +201,7 @@ call_condition_range_date <- function(varname, range) { #' Get call to subset and select array #' #' @param dataname (`character(1)` or `name`). -#' @param row (`name` or `call` or `logical` or `integer` or `character`) optional, +#' @param row (`name`, `call`, `logical`, `integer` or `character`) optional #' name of the `row` or condition. #' @param column (`name` or `call` or `logical` or `integer` or `character`) optional, #' name of the `column` or condition. From 44d5c0e9ab7419396bac8b14e8d237d6a15fc42e Mon Sep 17 00:00:00 2001 From: kartikeya kirar Date: Thu, 14 Mar 2024 17:55:22 +0530 Subject: [PATCH 5/8] Update R/call_utils.R Co-authored-by: Marcin <133694481+m7pr@users.noreply.github.com> Signed-off-by: kartikeya kirar --- R/call_utils.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/call_utils.R b/R/call_utils.R index 33b14680..69915cc0 100644 --- a/R/call_utils.R +++ b/R/call_utils.R @@ -203,7 +203,7 @@ call_condition_range_date <- function(varname, range) { #' @param dataname (`character(1)` or `name`). #' @param row (`name`, `call`, `logical`, `integer` or `character`) optional #' name of the `row` or condition. -#' @param column (`name` or `call` or `logical` or `integer` or `character`) optional, +#' @param column (`name`, `call`, `logical`, `integer` or `character`) optional #' name of the `column` or condition. #' @param aisle (`name` or `call` or `logical` or `integer` or `character`) optional, #' name of the `row` or condition. From 1a0777634ceaf5e0341e92865c71ed66e696c1da Mon Sep 17 00:00:00 2001 From: "27856297+dependabot-preview[bot]@users.noreply.github.com" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Thu, 14 Mar 2024 12:28:26 +0000 Subject: [PATCH 6/8] [skip roxygen] [skip vbump] Roxygen Man Pages Auto Update --- man/call_extract_array.Rd | 4 ++-- man/select_spec.Rd | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/man/call_extract_array.Rd b/man/call_extract_array.Rd index 3b4a50ae..78c80391 100644 --- a/man/call_extract_array.Rd +++ b/man/call_extract_array.Rd @@ -9,10 +9,10 @@ call_extract_array(dataname = ".", row = NULL, column = NULL, aisle = NULL) \arguments{ \item{dataname}{(\code{character(1)} or \code{name}).} -\item{row}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional, +\item{row}{(\code{name}, \code{call}, \code{logical}, \code{integer} or \code{character}) optional name of the \code{row} or condition.} -\item{column}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional, +\item{column}{(\code{name}, \code{call}, \code{logical}, \code{integer} or \code{character}) optional name of the \code{column} or condition.} \item{aisle}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional, diff --git a/man/select_spec.Rd b/man/select_spec.Rd index 934bcff3..e4ca7b4d 100644 --- a/man/select_spec.Rd +++ b/man/select_spec.Rd @@ -61,7 +61,7 @@ always be selected} \item{ordered}{(\code{logical(1)}) Flags whether selection order should be tracked.} -\item{label}{(\code{character}) optional, define a label on top of this specific +\item{label}{(\code{character}) optional, defines a label on top of this specific shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}. The default value is \code{"Select"}.} } \value{ From da165740a032b7f29e0b5ca184e25ca2633545c5 Mon Sep 17 00:00:00 2001 From: kartikeya kirar Date: Thu, 14 Mar 2024 18:33:40 +0530 Subject: [PATCH 7/8] Update R/filter_spec.R Co-authored-by: Marcin <133694481+m7pr@users.noreply.github.com> Signed-off-by: kartikeya kirar --- R/filter_spec.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/filter_spec.R b/R/filter_spec.R index da118efd..c0206e07 100644 --- a/R/filter_spec.R +++ b/R/filter_spec.R @@ -43,7 +43,7 @@ #' The `all_choices` object indicates selecting all possible choices. #' @param drop_keys (`logical`) optional, whether to drop filter column from the #' dataset keys, `TRUE` on default. -#' @param label (`character`) optional, define a label on top of this specific +#' @param label (`character`) optional, defines a label on top of this specific #' shiny [shiny::selectInput()]. The default value is `"Filter by"`. #' #' @return `filter_spec`-S3-class object or `delayed_filter_spec`-S3-class object. From f0cda7581c49dbb0edc51690b5868d1e0a89fffc Mon Sep 17 00:00:00 2001 From: unknown Date: Thu, 14 Mar 2024 18:36:02 +0530 Subject: [PATCH 8/8] @m7pr suggestions. --- R/call_utils.R | 10 +++++----- R/select_spec.R | 4 ++-- man/call_extract_array.Rd | 6 +++--- man/call_extract_matrix.Rd | 4 ++-- man/filter_spec.Rd | 2 +- man/filter_spec_internal.Rd | 2 +- man/select_spec.Rd | 4 ++-- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/R/call_utils.R b/R/call_utils.R index 69915cc0..8811c04a 100644 --- a/R/call_utils.R +++ b/R/call_utils.R @@ -201,11 +201,11 @@ call_condition_range_date <- function(varname, range) { #' Get call to subset and select array #' #' @param dataname (`character(1)` or `name`). -#' @param row (`name`, `call`, `logical`, `integer` or `character`) optional +#' @param row (`name` or `call` or `logical` or `integer` or `character`) optional #' name of the `row` or condition. -#' @param column (`name`, `call`, `logical`, `integer` or `character`) optional +#' @param column (`name` or `call` or `logical` or `integer` or `character`) optional #' name of the `column` or condition. -#' @param aisle (`name` or `call` or `logical` or `integer` or `character`) optional, +#' @param aisle (`name` or `call` or `logical` or `integer` or `character`) optional #' name of the `row` or condition. #' #' @return [Extract()] `call` for 3-dimensional array in `x[i, j, k]` notation. @@ -251,9 +251,9 @@ call_extract_array <- function(dataname = ".", row = NULL, column = NULL, aisle #' Get call to subset and select matrix #' #' @param dataname (`character(1)` or `name`). -#' @param row (`name` or `call` or `logical` or `integer` or `character`) optional, +#' @param row (`name` or `call` or `logical` or `integer` or `character`) optional #' name of the `row` or condition. -#' @param column (`name` or `call` or `logical` or `integer` or `character`) optional, +#' @param column (`name` or `call` or `logical` or `integer` or `character`) optional #' name of the `column` or condition. #' #' @return [Extract()] `call` for matrix in `x[i, j]` notation. diff --git a/R/select_spec.R b/R/select_spec.R index 719f3b8a..426ba7be 100644 --- a/R/select_spec.R +++ b/R/select_spec.R @@ -13,13 +13,13 @@ #' These have to be columns in the dataset defined in the [data_extract_spec()] #' where this is called. #' `delayed_data` objects can be created via [variable_choices()] or [value_choices()]. -#' @param selected (`character` or `NULL` or `all_choices` or `delayed_data`) optional, +#' @param selected (`character` or `NULL` or `all_choices` or `delayed_data`) optional #' named character vector to define the selected values of a shiny [shiny::selectInput()]. #' Passing an `all_choices()` object indicates selecting all possible choices. #' Defaults to the first value of `choices` or `NULL` for delayed data loading. #' @param multiple (`logical`) Whether multiple values shall be allowed in the #' shiny [shiny::selectInput()]. -#' @param fixed (`logical`) optional, [data_extract_spec()] specific feature to +#' @param fixed (`logical`) optional [data_extract_spec()] specific feature to #' hide the choices selected in case they are not needed. Setting fixed to `TRUE` #' will not allow the user to select columns. It will then lead to a selection of #' columns in the dataset that is defined by the developer of the app. diff --git a/man/call_extract_array.Rd b/man/call_extract_array.Rd index 78c80391..1cad599f 100644 --- a/man/call_extract_array.Rd +++ b/man/call_extract_array.Rd @@ -9,13 +9,13 @@ call_extract_array(dataname = ".", row = NULL, column = NULL, aisle = NULL) \arguments{ \item{dataname}{(\code{character(1)} or \code{name}).} -\item{row}{(\code{name}, \code{call}, \code{logical}, \code{integer} or \code{character}) optional +\item{row}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional name of the \code{row} or condition.} -\item{column}{(\code{name}, \code{call}, \code{logical}, \code{integer} or \code{character}) optional +\item{column}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional name of the \code{column} or condition.} -\item{aisle}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional, +\item{aisle}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional name of the \code{row} or condition.} } \value{ diff --git a/man/call_extract_matrix.Rd b/man/call_extract_matrix.Rd index 90e49eaa..6ae8514d 100644 --- a/man/call_extract_matrix.Rd +++ b/man/call_extract_matrix.Rd @@ -9,10 +9,10 @@ call_extract_matrix(dataname = ".", row = NULL, column = NULL) \arguments{ \item{dataname}{(\code{character(1)} or \code{name}).} -\item{row}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional, +\item{row}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional name of the \code{row} or condition.} -\item{column}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional, +\item{column}{(\code{name} or \code{call} or \code{logical} or \code{integer} or \code{character}) optional name of the \code{column} or condition.} } \value{ diff --git a/man/filter_spec.Rd b/man/filter_spec.Rd index 2d2c1423..e5450b48 100644 --- a/man/filter_spec.Rd +++ b/man/filter_spec.Rd @@ -46,7 +46,7 @@ The \code{all_choices} object indicates selecting all possible choices.} \item{multiple}{(\code{logical}) Whether multiple values shall be allowed in the shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}.} -\item{label}{(\code{character}) optional, define a label on top of this specific +\item{label}{(\code{character}) optional, defines a label on top of this specific shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}. The default value is \code{"Filter by"}.} \item{sep}{(\code{character}) A separator string to split the \code{choices} or diff --git a/man/filter_spec_internal.Rd b/man/filter_spec_internal.Rd index ca16aa86..bc95ad6d 100644 --- a/man/filter_spec_internal.Rd +++ b/man/filter_spec_internal.Rd @@ -96,7 +96,7 @@ Named character vector to define the selected values of a shiny \code{\link[shin This value will be displayed inside the shiny app upon start. The \code{all_choices} object indicates selecting all possible choices.} -\item{label}{(\code{character}) optional, define a label on top of this specific +\item{label}{(\code{character}) optional, defines a label on top of this specific shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}. The default value is \code{"Filter by"}.} \item{fixed}{(\code{logical}) diff --git a/man/select_spec.Rd b/man/select_spec.Rd index e4ca7b4d..67554c4d 100644 --- a/man/select_spec.Rd +++ b/man/select_spec.Rd @@ -43,7 +43,7 @@ These have to be columns in the dataset defined in the \code{\link[=data_extract where this is called. \code{delayed_data} objects can be created via \code{\link[=variable_choices]{variable_choices()}} or \code{\link[=value_choices]{value_choices()}}.} -\item{selected}{(\code{character} or \code{NULL} or \code{all_choices} or \code{delayed_data}) optional, +\item{selected}{(\code{character} or \code{NULL} or \code{all_choices} or \code{delayed_data}) optional named character vector to define the selected values of a shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}. Passing an \code{all_choices()} object indicates selecting all possible choices. Defaults to the first value of \code{choices} or \code{NULL} for delayed data loading.} @@ -51,7 +51,7 @@ Defaults to the first value of \code{choices} or \code{NULL} for delayed data lo \item{multiple}{(\code{logical}) Whether multiple values shall be allowed in the shiny \code{\link[shiny:selectInput]{shiny::selectInput()}}.} -\item{fixed}{(\code{logical}) optional, \code{\link[=data_extract_spec]{data_extract_spec()}} specific feature to +\item{fixed}{(\code{logical}) optional \code{\link[=data_extract_spec]{data_extract_spec()}} specific feature to hide the choices selected in case they are not needed. Setting fixed to \code{TRUE} will not allow the user to select columns. It will then lead to a selection of columns in the dataset that is defined by the developer of the app.}