mts_filterDatetime.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/mts_filterDatetime.R
\name{mts_filterDatetime}
\alias{mts_filterDatetime}
\title{Datetime filtering for \emph{mts} time series objects}
\usage{
mts_filterDatetime(
  mts = NULL,
  startdate = NULL,
  enddate = NULL,
  timezone = NULL,
  unit = "sec",
  ceilingStart = FALSE,
  ceilingEnd = FALSE,
  includeEnd = FALSE
)
}
\arguments{
\item{mts}{\emph{mts} object.}

\item{startdate}{Desired start datetime (ISO 8601).}

\item{enddate}{Desired end datetime (ISO 8601).}

\item{timezone}{Olson timezone used to interpret dates.}

\item{unit}{Datetimes will be rounded to the nearest \code{unit}.}

\item{ceilingStart}{Logical instruction to apply
\code{\link[lubridate]{ceiling_date}} to the \code{startdate} rather than
\code{\link[lubridate]{floor_date}} when rounding.}

\item{ceilingEnd}{Logical instruction to apply
\code{\link[lubridate]{ceiling_date}} to the \code{enddate} rather than
\code{\link[lubridate]{floor_date}} when rounding.}

\item{includeEnd}{Logical specifying that records associated with \code{enddate}
should be included.}
}
\value{
A subset of the incoming \emph{mts} time series object.
(A list with \code{meta} and \code{data} dataframes.)
}
\description{
\strong{\code{DEPRECATED -- use \link{mts_setTimeAxis}}}.

Subsets an \code{mts} object by datetime. This function
allows for sub-day filtering as opposed to \code{mts_filterDate()} which
always filters to day-boundaries. Both the \code{startdate} and the
\code{enddate} will be included in the subset.

Datetimes can be anything that is understood by
\code{MazamaCoreUtils::parseDatetime()}. For non-\code{POSIXct} values,
the recommended format is \code{"YYYY-mm-dd HH:MM:SS"}.

Timezone determination precedence assumes that if you are passing in
\code{POSIXct} values then you know what you are doing:

\enumerate{
\item{get timezone from \code{startdate} if it is \code{POSIXct}}
\item{use passed in \code{timezone}}
\item{get timezone from \code{mts}}
}
}
\note{
This function is deprecated as of \strong{MazamaTimeSeries 0.2.15}.
Please use \link{mts_setTimeAxis} to shorten or lengthen the time axis
of an \emph{mts} object.
}
\seealso{
\link{mts_filterData}

\link{mts_filterDate}

\link{mts_filterMeta}
}