R/lapply.R

In moritzlindner/PatchR: An environment for working with ephys (PatchClamp) recordings

#' apply function for PCollection objects
#'
#' `r lifecycle::badge("stable")` \cr
#' This is the PatchMastR analog to "lapply" for PCollection objects
#'
#' @param X a \linkS4class{PCollection} object
#' @param FUN the function to be applied
#' @return A \linkS4class{PCollection} object
#' @param ReturnPObject whether to return results as a \linkS4class{PCollection}  Default is \var{FALSE}, then returns a list
#' @exportMethod lapply
setMethod("lapply",
          "PCollection",
          function(X, FUN, ReturnPObject = F) {
            dat <- lapply(X@Recordings, FUN)
            if (ReturnPObject) {
              X@Recordings <- dat
              if (!validPCollection(X)) {
                stop(
                  paste(
                    "Applying to PCollection",
                    deparse(substitute(object)),
                    "failed. No valid PCollection object returned"
                  )
                )
              }
              return(X)
            } else{
              dat <- t(as.data.frame(dat))
              rownames(dat) <- X@Names
              dat
            }
          })