R/summary_of_values.R

In andreas50/utsMultivariate: Multivariate Unevenly Spaced Time Series

##############################################################
# Methods that calculate summaries of the observation values #
##############################################################

#' Summary of Time Series Values
#' 
#' Apply \code{\link{summary}} from base \R to the observation values of a multivariate time series.
#' 
#' @note This method primarily exists because \code{\link{summary.default}} produces an error message.
#'  
#' @param object a \code{"uts_vector"} or \code{"uts_matrix"} object.
#' @param \dots further arguments passed to or from methods.
#' 
#' @keywords internal
#' @seealso \code{\link[uts]{summary.uts}}
#' @examples
#' summary(ex_uts_vector())
#' summary(ex_uts_matrix())
summary.uts_vector <- function(object, ...)
{
  out <- sapply(object, summary, ...)
  if (is.matrix(out))
    out <- t(out)
  out
}

#' @rdname summary.uts_vector
summary.uts_matrix <- function(object, ...)
{
  summary(as.uts_vector(object), ...)
}


#' Mean, Median, and Standard Deviation of Observation Values
#' 
#' Calculate the mean, median, and standard deviation, respectively, of the observation values of a multivariate time series.
#' 
#' @param x a \code{"uts_vector"} object.
#' @param \dots further arguments passed to or from methods.
#' 
#' @aliases mean.uts_matrix, median.uts_matrix, sd.uts_matrix
#' @seealso \code{\link[uts]{mean.uts}}, \code{\link[uts]{median.uts}}, \code{\link[uts]{sd.uts}}
#' @seealso \code{\link{mean}}, \code{\link{median}}, \code{\link{sd}} in base \R.

#' @keywords internal
#' @examples
#' mean(ex_uts_vector())
#' median(ex_uts_vector())
#' sd(ex_uts_vector())
#' 
#' mean(ex_uts_matrix())
#' median(ex_uts_matrix())
#' sd(ex_uts_matrix())
mean.uts_vector <- function(x, ...)
{
  sapply(x, mean, ...)
}

#' @rdname mean.uts_vector
median.uts_vector <- function(x, ...)
{
  sapply(x, median, ...)
}

#' @rdname mean.uts_vector
sd.uts_vector <- function(x, ...)
{
  sapply(x, sd, ...)
}