Skip to content

Commit 95cf535

Browse files
committed
Refactor tidy_ function parameters from 'object' to 'x' for consistency and clarity; update documentation accordingly.
1 parent 289e1ad commit 95cf535

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

R/methods.R

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ setClass("tidySummarizedExperiment",
1919
#' @importFrom generics tidy
2020

2121
#' @importFrom lifecycle deprecate_warn
22-
tidy_ <- function(object) {
22+
tidy_ <- function(x, ...) {
2323

2424
# DEPRECATE
2525
deprecate_warn(
@@ -28,20 +28,22 @@ tidy_ <- function(object) {
2828
details = "tidySummarizedExperiment says: tidy() is not needed anymore."
2929
)
3030

31-
object
31+
x
3232
}
3333

3434
#' @importFrom methods as
3535
#' @rdname tidy
36-
#' @param object A SummarizedExperiment object
36+
#' @param x A SummarizedExperiment object
37+
#' @param ... Additional arguments passed to methods
3738
#' @references
3839
#' Hutchison, W.J., Keyes, T.J., The tidyomics Consortium. et al. The tidyomics ecosystem: enhancing omic data analyses. Nat Methods 21, 1166–1170 (2024). https://doi.org/10.1038/s41592-024-02299-2
3940
#' @export
4041
tidy.SummarizedExperiment <- tidy_
4142

4243
#' @importFrom methods as
4344
#' @rdname tidy
44-
#' @param object A SummarizedExperiment object
45+
#' @param x A SummarizedExperiment object
46+
#' @param ... Additional arguments passed to methods
4547
#' @references
4648
#' Hutchison, W.J., Keyes, T.J., The tidyomics Consortium. et al. The tidyomics ecosystem: enhancing omic data analyses. Nat Methods 21, 1166–1170 (2024). https://doi.org/10.1038/s41592-024-02299-2
4749
#' @export

man/tidy.Rd

Lines changed: 8 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)