R/ts_compatability.R

In andreas50/utsMultivariate: Multivariate Unevenly Spaced Time Series

#############################################################################
# Methods for ensuring compatability with base R methods for the "ts" calss #
#############################################################################

#' Compatability with ts class
#' 
#' These methods exist solely to ensure that methods intended for \code{"ts"} objects in base \R are not accidentally applied to \code{"uts_vector"} and \code{"uts_matrix"} objects.
#'
#' @param \dots further arguments passed to or from methods.
#' 
#' @keywords internal
#' @seealso \code{\link{ts}}
#' @name compatability
NULL


#' @rdname compatability
#'
#' @examples
#' \dontrun{as.ts(ex_uts_vector())}
as.ts.uts_vector <- function(x, ...)
{
  stop("Unevenly spaced time series vectors cannot be coerced to 'ts' objects")
}


#' @rdname compatability
#' 
#' @return \code{cycle()} and \code{frequency()} give an error message, because  \code{"uts_vector"} and \code{"uts_matrix"} objects objects, by definition, do not have a fixed number of observations in a given time interval.
#' 
#' @examples
#' \dontrun{frequency(ex_uts_vector())}
frequency.uts_vector <- function(x, ...)
{
  stop("Unevenly spaced time series vectors do not have a frequency attribute")
}


#' @rdname compatability
#'
#' @examples
#' \dontrun{cycle(ex_uts_vector())}
cycle.uts_vector <- function(x, ...)
{
  stop("Unevenly spaced time series vectors objects do not have observation cycles")
}