From 0eadcef4c5366e82e33c65aca361fcaa288c2e06 Mon Sep 17 00:00:00 2001
From: m7pr <marcin.kosinski.mk1@roche.com>
Date: Mon, 4 Mar 2024 16:01:04 +0100
Subject: [PATCH] document parameters for format in teal_slices

---
 R/teal_slices.R    | 12 ++++++------
 man/teal_slices.Rd | 12 ++++++++----
 2 files changed, 14 insertions(+), 10 deletions(-)

diff --git a/R/teal_slices.R b/R/teal_slices.R
index de1f072d6..44d06655a 100644
--- a/R/teal_slices.R
+++ b/R/teal_slices.R
@@ -27,10 +27,12 @@
 #'  - `"all"` to have counts of single `FilterState` to show number of observation in filtered
 #'   and unfiltered dataset. Note, that issues were reported when using this option with `MultiAssayExperiment`.
 #'   Please make sure that adding new filters doesn't fail on target platform before deploying for production.
-#' @param allow_add (`logical(1)`) logical flag specifying whether the user will be able to add new filters
-#' @param x object to test for `teal_slices`, object to convert to `teal_slices` or a `teal_slices` object
-#' @param i (`character` or `numeric` or `logical`) indicating which elements to extract
-#' @param recursive (`logical(1)`) flag specifying whether to also convert to list the elements of this `teal_slices`
+#' @param allow_add (`logical(1)`) logical flag specifying whether the user will be able to add new filters.
+#' @param x object to test for `teal_slices`, object to convert to `teal_slices` or a `teal_slices` object.
+#' @param i (`character` or `numeric` or `logical`) indicating which elements to extract.
+#' @param recursive (`logical(1)`) flag specifying whether to also convert to list the elements of this `teal_slices`.
+#' @param show_all (`logical(1)`) whether to display non-null elements of constituent `teal_slice` objects.
+#' @param trim_lines (`logical(1)`) whether to trim lines.
 #'
 #' @return
 #' `teal_slices`, which is an unnamed list of `teal_slice` objects.
@@ -225,8 +227,6 @@ c.teal_slices <- function(...) {
   )
 }
 
-#' @param show_all (`logical(1)`) whether to display non-null elements of constituent `teal_slice` objects
-#' @param trim_lines (`logical(1)`) whether to trim lines
 #' @export
 #' @keywords internal
 #'
diff --git a/man/teal_slices.Rd b/man/teal_slices.Rd
index 2ea45e952..b9f23b85e 100644
--- a/man/teal_slices.Rd
+++ b/man/teal_slices.Rd
@@ -52,13 +52,17 @@ and unfiltered dataset. Note, that issues were reported when using this option w
 Please make sure that adding new filters doesn't fail on target platform before deploying for production.
 }}
 
-\item{allow_add}{(\code{logical(1)}) logical flag specifying whether the user will be able to add new filters}
+\item{allow_add}{(\code{logical(1)}) logical flag specifying whether the user will be able to add new filters.}
 
-\item{x}{object to test for \code{teal_slices}, object to convert to \code{teal_slices} or a \code{teal_slices} object}
+\item{x}{object to test for \code{teal_slices}, object to convert to \code{teal_slices} or a \code{teal_slices} object.}
 
-\item{i}{(\code{character} or \code{numeric} or \code{logical}) indicating which elements to extract}
+\item{i}{(\code{character} or \code{numeric} or \code{logical}) indicating which elements to extract.}
 
-\item{recursive}{(\code{logical(1)}) flag specifying whether to also convert to list the elements of this \code{teal_slices}}
+\item{recursive}{(\code{logical(1)}) flag specifying whether to also convert to list the elements of this \code{teal_slices}.}
+
+\item{show_all}{(\code{logical(1)}) whether to display non-null elements of constituent \code{teal_slice} objects.}
+
+\item{trim_lines}{(\code{logical(1)}) whether to trim lines.}
 }
 \value{
 \code{teal_slices}, which is an unnamed list of \code{teal_slice} objects.