sts_filterDate {MazamaTimeSeries} | R Documentation |
Date filtering for sts time series objects
Description
Subsets a MazamaSingleTimeseries object by date. This function
always filters to day-boundaries. For sub-day filtering, use
sts_filterDatetime()
.
Dates can be anything that is understood by MazamaCoreUtils::parseDatetime()
including either of the following recommended formats:
"YYYYmmdd"
"YYYY-mm-dd"
Timezone determination precedence assumes that if you are passing in
POSIXct
values then you know what you are doing.
get timezone from
startdate
if it isPOSIXct
use passed in
timezone
get timezone from
sts
Usage
sts_filterDate(
sts = NULL,
startdate = NULL,
enddate = NULL,
timezone = NULL,
unit = "sec",
ceilingStart = FALSE,
ceilingEnd = FALSE
)
Arguments
sts |
MazamaSingleTimeseries sts object. |
startdate |
Desired start datetime (ISO 8601). |
enddate |
Desired end datetime (ISO 8601). |
timezone |
Olson timezone used to interpret dates. |
unit |
Units used to determine time at end-of-day. |
ceilingStart |
Logical instruction to apply
|
ceilingEnd |
Logical instruction to apply
|
Value
A subset of the incoming sts time series object.
(A list with meta
and data
dataframes.)
Note
The returned data will run from the beginning of startdate
until
the beginning of enddate
– i.e. no values associated
with enddate
will be returned. The exception being when
enddate
is less than 24 hours after startdate
. In that case, a
single day is returned.
See Also
Examples
library(MazamaTimeSeries)
example_sts %>%
sts_filterDate(startdate = 20180808, enddate = 20180815) %>%
sts_extractData() %>%
head()