52 standardise optional notation (#302)

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 · baf8b94 · baf8b94
1 parent 0247047
commit baf8b94
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 17 deletions.
diff --git a/R/cdisc_data.R b/R/cdisc_data.R
@@ -7,11 +7,10 @@
 #' for given datasets whose names match ADAM datasets names.
 #'
 #' @inheritParams teal_data
-#' @param join_keys (`join_keys`) object or a single (`join_key_set`) object
-#'
-#'   (optional) object with datasets column names used for joining.
-#'   If empty then it would be automatically derived basing on intersection of datasets primary keys.
-#'   For ADAM datasets it would be automatically derived.
+#' @param join_keys (`join_keys` or single `join_key_set`)
+#' optional object with datasets column names used for joining.
+#' If empty then it would be automatically derived basing on intersection of datasets primary keys.
+#' For ADAM datasets it would be automatically derived.
 #'
 #' @return A `teal_data` object.
 #'

diff --git a/R/join_keys.R b/R/join_keys.R
@@ -22,7 +22,7 @@
 #' - `join_keys(teal_data)`: Returns the `join_keys` object contained in `teal_data` object.
 #' - `join_keys(...)`: Creates a new object with one or more `join_key_set` parameters.
 #'
-#' @param ... (optional)
+#' @param ... optional,
 #' - either `teal_data` or `join_keys` object to extract `join_keys`
 #' - or any number of `join_key_set` objects to create `join_keys`
 #' - or nothing to create an empty `join_keys`

diff --git a/R/teal_data.R b/R/teal_data.R
@@ -7,10 +7,9 @@
 #'
 #' @param ... any number of objects (presumably data objects) provided as `name = value` pairs.
 #'
-#' @param join_keys (`join_keys`) object or a single (`join_key_set`) object.
-#'
-#'  (optional) object with dataset column relationships used for joining.
-#'  If empty then no joins between pairs of objects.
+#' @param join_keys (`join_keys` or single `join_key_set`)
+#' optional object with datasets column names used for joining.
+#' If empty then no joins between pairs of objects.
 #'
 #' @param code (`character`, `language`) optional code to reproduce the datasets provided in `...`.
 #'  Note this code is not executed and the `teal_data` may not be reproducible

diff --git a/man/cdisc_data.Rd b/man/cdisc_data.Rd
diff --git a/man/join_keys.Rd b/man/join_keys.Rd
diff --git a/man/teal_data.Rd b/man/teal_data.Rd