Merge pull request #89 from stemangiola/tidy-generics

Tidy generics

Author: stemangiola

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: tidyseurat
 Title: Brings Seurat to the Tidyverse 
-Version: 0.8.4
+Version: 0.8.5
 Authors@R: c(person("Stefano", "Mangiola", email = "[email protected]",
                   role = c("aut", "cre")),
             person("Maria", "Doyle", email = "[email protected]",
@@ -33,7 +33,8 @@ Imports:
     stringr,
     cli,
     fansi,
-    Matrix
+    Matrix,
+    generics
 Suggests:
     testthat,
     knitr,

NAMESPACE

@@ -49,7 +49,6 @@ export(get_abundance_sc_long)
 export(get_abundance_sc_wide)
 export(join_transcripts)
 export(plot_ly)
-export(tidy)
 export(unnest_seurat)
 exportMethods(aggregate_cells)
 exportMethods(join_features)
@@ -95,6 +94,7 @@ importFrom(dplyr,summarise)
 importFrom(dplyr,summarize)
 importFrom(dplyr,vars)
 importFrom(fansi,strwrap_ctl)
+importFrom(generics,tidy)
 importFrom(ggplot2,aes)
 importFrom(ggplot2,ggplot)
 importFrom(lifecycle,deprecate_warn)

R/methods.R

@@ -15,26 +15,17 @@ setMethod(
 
 setClass("tidyseurat", contains="Seurat")
 
-#' @name tidy
-#' @rdname tidy
-#' @title tidy for `Seurat`
-#'
-#' @param object A `Seurat` object.
-#' @return A `tidyseurat` object.
-#'
-#' @examples
-#' data(pbmc_small)
-#' pbmc_small
-#'
-#' @export
-tidy <- function(object) {
-    UseMethod("tidy", object)
-}
+#' @importFrom generics tidy
 
-#' @rdname tidy
+#' @title tidy for Seurat objects
+#' @name tidy
+#' @description tidy for Seurat objects
+#' @param x A Seurat object
+#' @param ... Additional arguments (not used)
+#' @return A tidyseurat object
 #' @importFrom lifecycle deprecate_warn
 #' @export
-tidy.Seurat <- function(object){ 
+tidy.Seurat <- function(x, ...){ 
 
     # DEPRECATE
     deprecate_warn(
@@ -43,7 +34,7 @@ tidy.Seurat <- function(object){
         details="tidyseurat says: tidy() is not needed anymore."
     )
 
-    return(object)
+    return(x)
 }