52 standardise optional notation (#204)

part of insightsengineering/nestdevs-tasks#52 --------- Signed-off-by: kartikeya kirar <[email protected]> Co-authored-by: Marcin <[email protected]> Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
insightsengineering · Mar 14, 2024 · d0e573e · d0e573e
1 parent 3843e16
commit d0e573e
Show file tree

Hide file tree

Showing 19 changed files with 36 additions and 36 deletions.
diff --git 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
@@ -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
@@ -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, 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.

diff --git 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
@@ -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
@@ -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, 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.

diff --git 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
diff --git a/man/call_extract_matrix.Rd b/man/call_extract_matrix.Rd
diff --git a/man/choices_selected.Rd b/man/choices_selected.Rd
diff --git a/man/extract_choices_labels.Rd b/man/extract_choices_labels.Rd
diff --git a/man/filter_spec.Rd b/man/filter_spec.Rd
diff --git a/man/filter_spec_internal.Rd b/man/filter_spec_internal.Rd
diff --git a/man/get_dplyr_call.Rd b/man/get_dplyr_call.Rd
diff --git a/man/get_merge_key_i.Rd b/man/get_merge_key_i.Rd
diff --git a/man/get_rename_call.Rd b/man/get_rename_call.Rd
diff --git a/man/get_reshape_call.Rd b/man/get_reshape_call.Rd
diff --git a/man/parse_merge_key_i.Rd b/man/parse_merge_key_i.Rd
diff --git a/man/select_spec.Rd b/man/select_spec.Rd