Skip to content

Commit

Permalink
document parameters for format in teal_slices
Browse files Browse the repository at this point in the history
  • Loading branch information
m7pr committed Mar 4, 2024
1 parent a7070ef commit 0eadcef
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
12 changes: 6 additions & 6 deletions R/teal_slices.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
#'
Expand Down
12 changes: 8 additions & 4 deletions man/teal_slices.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 0eadcef

Please sign in to comment.