Skip to content

Commit abb3dda

Browse files
committed
Update tidy method for SingleCellExperiment
- Rename parameter from 'object' to 'x' in tidy.SingleCellExperiment function. - Update documentation to reflect the new parameter name and clarify usage. - Mark tidy method as deprecated, indicating it is no longer needed.
1 parent 17e5481 commit abb3dda

File tree

2 files changed

+10
-13
lines changed

2 files changed

+10
-13
lines changed

R/methods.R

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,11 @@ setMethod("join_features", "SingleCellExperiment", function(.data,
9393
}
9494
})
9595

96-
#' @name tidy
97-
#' @rdname tidy
9896
#' @title (DEPRECATED) tidy for `SingleCellExperiment`
97+
#' @name tidy.SingleCellExperiment
9998
#'
100-
#' @param object A `SingleCellExperiment` object.
99+
#' @param x A `SingleCellExperiment` object.
100+
#' @param ... Additional arguments passed to `generics::tidy`. (Unused.)
101101
#' @return A `tidySingleCellExperiment` object. (DEPRECATED - not needed anymore)
102102
#'
103103
#' @examples
@@ -108,19 +108,17 @@ setMethod("join_features", "SingleCellExperiment", function(.data,
108108
#' 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
109109
#'
110110
#' @importFrom generics tidy
111-
112-
#' @rdname tidy
113111
#' @importFrom lifecycle deprecate_warn
114112
#' @export
115-
tidy.SingleCellExperiment <- function(object) {
113+
tidy.SingleCellExperiment <- function(x, ...) {
116114

117115
# DEPRECATE
118116
deprecate_warn(
119117
when="1.1.1",
120118
what="tidy()",
121119
details="tidySingleCellExperiment says: tidy() is not needed anymore.")
122120

123-
return(object)
121+
return(x)
124122
}
125123

126124
#' @name aggregate_cells

man/tidy.Rd

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

0 commit comments

Comments
 (0)