52 standardise optional notation (#567)

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>

R/FilterStates-utils.R

@@ -10,9 +10,9 @@
 #' @param dataname (`character(1)`)
 #'   name of the data used in the subset expression,
 #'   passed to the function argument attached to this `FilterStates`.
-#' @param datalabel (`character(1)`)
-#'   optional text label.
-#' @param ... (optional)
+#' @param datalabel (`character(1)`) optional
+#'   text label.
+#' @param ... optional,
 #'   additional arguments for specific classes: keys.
 #'
 #' @return Object of class `FilterStates`.

R/FilterStates.R

@@ -40,8 +40,8 @@ FilterStates <- R6::R6Class( # nolint
     #' @param dataname (`character(1)`)
     #'   name of the dataset, used in the subset expression.
     #'   Passed to the function argument attached to this `FilterStates`.
-    #' @param datalabel (`character(1)`)
-    #'   optional text label.
+    #' @param datalabel (`character(1)`) optional
+    #'   text label.
     #'
     #' @return
     #' Object of class `FilterStates`, invisibly.

R/FilterStatesDF.R

@@ -174,8 +174,8 @@ DFFilterStates <- R6::R6Class( # nolint
     #' @param dataname (`character`)
     #'   name of the data used in the *subset expression*.
     #'   Passed to the function argument attached to this `FilterStates`.
-    #' @param datalabel (`character(1)`)
-    #'   optional text label.
+    #' @param datalabel (`character(1)`) optional
+    #'   text label.
     #' @param keys (`character`)
     #'   key column names.
     #'

R/FilterStatesMAE.R

@@ -24,8 +24,8 @@ MAEFilterStates <- R6::R6Class( # nolint
     #' @param dataname (`character(1)`)
     #'   name of the data used in the subset expression.
     #'   Passed to the function argument attached to this `FilterStates`.
-    #' @param datalabel (`character(1)`)
-    #'   optional text label.
+    #' @param datalabel (`character(1)`) optional
+    #'   text label.
     #' @param varlabels (`character`)
     #'   labels of the variables used in this object.
     #' @param keys (`character`)

R/FilterStatesMatrix.R

@@ -25,8 +25,8 @@ MatrixFilterStates <- R6::R6Class( # nolint
     #' @param dataname (`character(1)`)
     #'   name of the data used in the subset expression.
     #'   Passed to the function argument attached to this `FilterStates`.
-    #' @param datalabel (`character(1)`)
-    #'   Optional text label. Should be a name of experiment.
+    #' @param datalabel (`character(1)`) optional
+    #'   text label. Should be a name of experiment.
     #'
     initialize = function(data,
                           data_reactive = function(sid = "") NULL,

R/FilterStatesSE.R

@@ -25,8 +25,8 @@ SEFilterStates <- R6::R6Class( # nolint
     #' @param dataname (`character(1)`)
     #'   name of the data used in the expression
     #'   specified to the function argument attached to this `FilterStates`.
-    #' @param datalabel (`character(1)`)
-    #'   optional text label. Should be the name of experiment.
+    #' @param datalabel (`character(1)`) optional
+    #'   text label. Should be the name of experiment.
     #'
     initialize = function(data,
                           data_reactive = function(sid = "") NULL,

R/FilteredDataset-utils.R

@@ -4,9 +4,9 @@
 #'
 #' @param dataset any object
 #' @param dataname (`character(1)`)
-#'  syntactically valid name given to the dataset.
-#' @param keys (`character`)
-#'   optional vector of primary key column names.
+#'   syntactically valid name given to the dataset.
+#' @param keys (`character`) optional
+#'   vector of primary key column names.
 #' @param parent_name (`character(1)`)
 #'   name of the parent dataset.
 #' @param parent (`reactive`)

R/FilteredDataset.R

@@ -22,8 +22,8 @@ FilteredDataset <- R6::R6Class( # nolint
     #' @param dataset any object
     #' @param dataname (`character(1)`)
     #'  syntactically valid name given to the dataset.
-    #' @param keys (`character`)
-    #'   optional vector of primary key column names.
+    #' @param keys (`character`) optional
+    #'   vector of primary key column names.
     #' @param label (`character(1)`)
     #'   label to describe the dataset.
     #'

R/FilteredDatasetDataframe.R

@@ -45,8 +45,8 @@ DataframeFilteredDataset <- R6::R6Class( # nolint
     #'  single `data.frame` for which filters are rendered.
     #' @param dataname (`character(1)`)
     #'  syntactically valid name given to the dataset.
-    #' @param keys (`character`)
-    #'   optional vector of primary key column names.
+    #' @param keys (`character`) optional
+    #'  vector of primary key column names.
     #' @param parent_name (`character(1)`)
     #'   name of the parent dataset.
     #' @param parent (`reactive`)

R/FilteredDatasetMAE.R

@@ -44,8 +44,8 @@ MAEFilteredDataset <- R6::R6Class( # nolint
     #'  single `MulitiAssayExperiment` for which filters are rendered.
     #' @param dataname (`character(1)`)
     #'  syntactically valid name given to the dataset.
-    #' @param keys (`character`)
-    #'   optional vector of primary key column names.
+    #' @param keys (`character`) optional
+    #'   vector of primary key column names.
     #' @param label (`character(1)`)
     #'   label to describe the dataset.
     #'

R/teal_slice.R

@@ -55,18 +55,18 @@
 #'  Must be a valid `R` expression which can be evaluated in the context of the data set.
 #'  For a `data.frame` `var == "x"` is sufficient, but `MultiAssayExperiment::subsetByColData`
 #'  requires `dataname` prefix, *e.g.* `data$var == "x"`.
-#' @param choices (optional `vector`) specifying allowed choices;
+#' @param choices (`vector`) optional, specifies allowed choices;
 #' When specified it should be a subset of values in variable denoted by `varname`;
 #' Type and size depends on variable type. Factors are coerced to character.
-#' @param selected (optional `vector`) of selected values from `choices`;
+#' @param selected (`vector`) optional, specifies selected values from `choices`;
 #' Type and size depends on variable type. Factors are coerced to character.
-#' @param multiple (optional `logical(1)`) flag specifying whether more than one value can be selected;
+#' @param multiple (`logical(1)`) optional flag specifying whether more than one value can be selected;
 #' only applicable to `ChoicesFilterState` and `LogicalFilterState`
-#' @param keep_na (optional `logical(1)`) flag specifying whether to keep missing values
-#' @param keep_inf (optional `logical(1)`) flag specifying whether to keep infinite values
+#' @param keep_na (`logical(1)`) optional flag specifying whether to keep missing values
+#' @param keep_inf (`logical(1)`) optional flag specifying whether to keep infinite values
 #' @param fixed (`logical(1)`) flag specifying whether to fix this filter state (forbid setting state)
 #' @param anchored (`logical(1)`) flag specifying whether to lock this filter state (forbid removing and inactivating)
-#' @param title (optional `character(1)`) title of the filter. Ignored when `varname` is set.
+#' @param title (`character(1)`) optional title of the filter. Ignored when `varname` is set.
 #' @param ... in `teal_slice` method these are additional arguments which can be handled by extensions
 #'  of `teal.slice` classes. In other methods these are further arguments passed to or from other methods.
 #' @param x (`teal.slice`)