Skip to content

Commit

Permalink
add aliases and remove object names from S3 classes in usage
Browse files Browse the repository at this point in the history
  • Loading branch information
m7pr committed Mar 5, 2024
1 parent f4cf7b9 commit 8b446da
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 6 deletions.
8 changes: 5 additions & 3 deletions R/teal_slice.R
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@
#' as.teal_slice(x)
#'
#' ## S3 method for class 'teal_slice'
#' as.list.teal_slice(x, ...)
#' as.list(x, ...)
#'
#' ## S3 method for class 'teal_slice'
#' format.teal_slice(x, show_all = FALSE, trim_lines = TRUE, ...)
#' format(x, show_all = FALSE, trim_lines = TRUE, ...)
#'
#' ## S3 method for class 'teal_slice'
#' print.teal_slice(x, ...)
#' print(x, ...)
#'
#' @details
#' `teal_slice` object fully describes filter state and can be used to create,
Expand Down Expand Up @@ -142,6 +142,8 @@
#'
#' @seealso [`teal_slices`]
#'
#' @aliases is.teal_slice as.teal_slice as.list.teal_slice format.teal_slice print.teal_slice
#'
#' @export
teal_slice <- function(dataname, # When editing function parameters, please remember to update @usage section.
varname,
Expand Down
2 changes: 2 additions & 0 deletions R/teal_slices.R
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@
#' - [`teal_slice`] for creating constituent elements of `teal_slices`
#' - [`teal::slices_store`] for robust utilities for saving and loading `teal_slices` in `JSON` format
#'
#' @aliases is.teal_slices as.teal_slices as.list.teal_slices format.teal_slices print.teal_slices c.teal_slices
#'
#' @export
#'
teal_slices <- function(..., # When editing function parameters, please remember to update @usage section.
Expand Down
11 changes: 8 additions & 3 deletions man/teal_slice.Rd

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

6 changes: 6 additions & 0 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 8b446da

Please sign in to comment.