R/summary.rainflow.R

Defines functions summary.rainflow

Documented in summary.rainflow

#' S3 method for object of type \code{rainflow}
#'
#' @author Addison Klinke, \email{agk38@case.edu}
#' 
#' @param r An object of type \code{rainflow} returned from 
#' \link[rainflow]{CountCycles}.
#'
#' @return None.
#' @export

summary.rainflow <- function(r) {
  cat(sprintf(paste0("%.1f cycles detected\n",
                     "%.3f average cycle amplitude\n",
                     "%.3f average cycle mean\n"), 
              sum(r$cycles),
              mean(r$amplitude),
              mean(r$mean)))
}
addisonklinke/rainflow documentation built on Aug. 23, 2020, 10:48 a.m.