R/print.summary.Cosinor.R

Defines functions print.summary.Cosinor

Documented in print.summary.Cosinor

# print.summary.Cosinor.R
# October 2011

#' printing a summary of a Cosinor
#' @name  print.summary.Cosinor
#' @param x a \code{summary.Cosinor} object produced by \code{summary.Cosinor}
#' @param \dots optional arguments to \code{print} or \code{plot} methods.
#' @method print summary.Cosinor 
#' @export
print.summary.Cosinor <- function(x, ...){
  ## report results
  if (class(x)!="summary.Cosinor"){
    stop("Object must be of class 'summary.Cosinor'")
  } 
# fix the digits, October 2011
 if(x$text!=TRUE){
    x$phase=round(x$phase,x$digits)
    x$lphase=round(x$lphase,x$digits)
 }

  cat('Cosinor test:\n')
  cat('Number of observations =',x$n,'\n')
  cat('Amplitude =',round(x$amp,x$digits),x$amp.scale,'\n')
  cat('Phase:',x$phase,'\n')
  cat('Low point:',x$lphase,'\n')
  if(x$type=='hourly'){
    cat('Significant circadian pattern based on adjusted significance level of',
        eval(x$alpha)/2,' = ',x$significant,'\n', ...)
  }
  if(x$type!='hourly'){
    cat('Significant seasonality based on adjusted significance level of',
        eval(x$alpha)/2,' = ',x$significant,'\n', ...)
  }
  
  # Added March 2020
  cat('\nRegression coefficients:\n')
  print(data.frame(x$ctable))
}
agbarnett/season documentation built on March 26, 2022, 9:29 a.m.