Fix issue #120 and push to Bioc

Author: charles-plessy

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: CAGEr
 Title: Analysis of CAGE (Cap Analysis of Gene Expression) sequencing data for precise mapping of transcription start sites and promoterome mining
-Version: 2.11.3
-Date: 2024-05-24
+Version: 2.11.4
+Date: 2024-08-02
 Authors@R:
   c( person("Vanja",   "Haberle",   email = "vanja.haberle@gmail.com",       role = "aut"),
      person("Charles", "Plessy",    email = "charles.plessy@oist.jp",        role = "cre"),

NAMESPACE

@@ -40,6 +40,7 @@ export(distclu)
 export(exportToTrack)
 export(expressionClasses)
 export(filterLowExpCTSS)
+export(filteredCTSSidx)
 export(findStrandInvaders)
 export(flagByUpstreamSequences)
 export(flagLowExpCTSS)

NEWS.md

@@ -1,4 +1,4 @@
-# Upcoming changes in version 2.11.4
+# Changes in version 2.11.4
 
 BACKWARDS-INCOMPATIBLE CHANGES
 
@@ -8,6 +8,11 @@ NEW FEATURES
 
 -   Support the use of `TxDB` objects for annotating clusters.
 
+BUG FIXES
+
+-   Fix issue #120 introduced in 2.11.3, where clustering functions would
+    fail if `filterLowExpCTSS` was not run before.
+
 # Changes in version 2.11.3
 
 BACKWARDS-INCOMPATIBLE CHANGES

R/CAGEr.R

@@ -182,6 +182,8 @@ setMethod("validSamples", "CAGEr", function (object, x){
 #' 
 #' @export
 #' 
+#' @family CAGEr filter functions
+#' 
 #' @examples
 #' flagLowExpCTSS(exampleCAGEexp, threshold = 100, nrPassThreshold = 2)
 

R/GetMethods.R

@@ -454,13 +454,32 @@ setMethod( "tagClustersGR", "CAGEexp"
   .TagClusters(tc)
 })
 
-#' @name filteredCTSSidx
-#' @noRd
+#' The `filteredCTSSidx()` function is in _CAGEr_ functions to retrieve the
+#' result of the `flagLowExpCTSS()` function in a safe way.
+#' 
+#' @returns Returns the value of `filteredCTSSidx` in the row ranges of the
+#' tag count matrix experiment of the `CAGEexp` object, or `Rle(TRUE)` if it
+#' was `NULL`
+#' 
+#' @param object A [`CAGEexp`] object
+#' 
+#' @export
+#' 
+#' @examples
+#' 
+#' filteredCTSSidx(exampleCAGEexp)
+#' 
+#' @family CAGEr filter functions
+#' @family CAGEr accessor methods
 
 setGeneric("filteredCTSSidx", function(object) standardGeneric("filteredCTSSidx"))
 
+#' @rdname filteredCTSSidx
+
 setMethod("filteredCTSSidx", "CAGEexp", function (object){
-  rowData(CTSStagCountSE(object))$filteredCTSSidx
+  res <- rowData(CTSStagCountSE(object))$filteredCTSSidx
+  if (is.null(res)) return(Rle(TRUE))
+  res
 })