Nothing
# File subdaily2daily.R
# Part of the hydroTSM R package, https://github.com/hzambran/hydroTSM ;
# https://CRAN.R-project.org/package=hydroTSM
# Copyright 2013-2023 Mauricio Zambrano-Bigiarini
# Distributed under GPL 2 or later
################################################################################
# subdaily2daily #
################################################################################
# This function transform a SUB-DAILY time series into a DAILY one
# 'x' : usb-daily values that will be converted into daily ones.
# class(x) must be 'xts'
# 'FUN' : Function that have to be applied for transforming from sub-daily into
# daily time step. E.g., for precipitation FUN MUST be "sum"
# For temperature and flow time series, FUN MUST be "mean"
# 'na.rm' : Logical. Should missing values be removed?
# TRUE : the monthly and annual values are computed considering only those
# values different from NA
# FALSE: if there is AT LEAST one NA within a year, the monthly and annual
# values are NA
# 'start' : character, indicating the starting time used for aggregating sub-daily time
# series into daily ones.
# It MUST be provided in the format specified by \code{start.fmt}. \cr
# This value is used to define the time when a new day begins (e.g., for some
# rain gauge stations). \cr
# -) All the values of \code{x} with a time attribute before \code{start} are
# considered as belonging to the day before the one indicated in the time
# attribute of those values. \cr
# -) All the values of \code{x} with a time attribute equal to \code{start}
# are considered to be equal
# to \code{"00:00:00"} in the output zoo object. \cr
# -) All the values of \code{x} with a time attribute after \code{start} are
# considered as belonging to the same day as the one indicated in the time
# attribute of those values. \cr
# It is useful when the daily values start at a time different from
# \code{"00:00:00"}. Use with caution. See examples.
# 'start.fmt': character indicating the format in which the time is provided in \code{start}.
# By default \code{date.fmt=\%H:\%M:\%S}. See \code{format} in
# \code{\link[base]{as.POSIXct}}.
# 'tz' : character, with the specification of the time zone used in both
# \code{x} and \code{start}.
# System-specific (see time zones), but \code{""} is the current time zone,
# and \code{"GMT"} is UTC (Universal Time, Coordinated).
# See \code{\link[base]{Sys.timezone}} and \code{\link[base]{as.POSIXct}}. \cr
# If \code{tz} is missing (the default), it is automatically set to the
# time zone used in \code{time(x)}. \cr
# This argument can be used to force using the local time zone or any other
# time zone instead of UTC as time zone.
subdaily2daily <-function(x, ...) UseMethod("subdaily2daily")
################################################################################
# Author : Mauricio Zambrano-Bigiarini #
################################################################################
# Started: 09-Apr-2013 #
# Updates: 06-Dec-2019 #
# 27-May-2021 #
# 11-Oct-2022 #
# 30-Jul-2023 ; 03-Aug-2023 #
################################################################################
subdaily2daily.default <- function(x, FUN, na.rm=TRUE, na.rm.max=0, start="00:00:00",
start.fmt= "%H:%M:%S", tz, ...) {
# Checking that 'x' is a zoo object
if ( !is.zoo(x) ) stop("Invalid argument: 'class(x)' must be 'zoo'")
# Automatic detection of 'tz'
#if (missing(tz)) tz <- ""
if (missing(tz)) tz <- format(time(x), "%Z")[1]
subdaily2daily.zoo(x=x, FUN=FUN, na.rm=na.rm, na.rm.max=na.rm.max,
start=start, start.fmt=start.fmt, tz=tz, ...)
} # 'subdaily2daily.default' end
################################################################################
# Author : Mauricio Zambrano-Bigiarini #
################################################################################
# Started: 25-Mar-2013 #
# Updates: 26-Mar-2013 ; 08-Apr-2013 ; 09-Apr-2013 #
# 29-Nov-2015 ; 01-Dec-2015 #
# 06-Dec-2019 ; 18-Dec-2019 #
# 27-May-2021 #
# 11-Oct-2022 #
# 30-Jul-2023 ; 31-Jul-2023 ; 03-Aug-2023 #
################################################################################
subdaily2daily.zoo <- function(x, FUN, na.rm=TRUE, na.rm.max=0, start="00:00:00",
start.fmt= "%H:%M:%S", tz, ...) {
# testing the existence of 'na.rm' argument
#args <- list(...)
#exist <- "na.rm" %in% names(args)
#exist
# Checking that the user provied a valid class for 'x'
if ( !is.zoo(x) ) stop("Invalid argument: 'class(x)' must be 'zoo' !!")
# Checking the user provide a valid value for 'FUN'
if ( missing(FUN) | !is.function(FUN) )
stop("Missing argument: 'FUN' must contain a valid function for aggregating the sub-daily values")
# Automatic detection of 'tz'
#if (missing(tz)) tz <- ""
if (missing(tz)) tz <- format(time(x), "%Z")[1]
# Analysis of days different from 00:00 to 23:59 hrs
if ( start != "00:00:00" ) {
# Storing the original time
time.old <- time(x)
# Converting the new starting time provided by the user into a POSIXct object
start <- as.POSIXct(start, format=start.fmt, tz=tz)
# normal staring time for a day
nstart <- as.POSIXct("00:00:00", format="%H:%M:%S", tz=tz)
# time difference between the desired starting time 'strat' and the "normal"
# starting time 'nstart', [s]
delta <- difftime(start, nstart, units="secs")
# Computing teh time difference between 'start' and the "normal" starting time, [s]
#time.new <- as.POSIXct(time.old, tz=tz) - delta
time.new <- time.old - delta
# Changing the time in 'x' in 'delta' seconds
time(x) <- time.new
} # IF end
# Making sure that the time serie is complete before aggregation
# This is useful when the first element of 'x' is not given at the time defined by 'start'.
# For example, if the first element of 'x' starts at 08:00:00 hrs, but 'start=00:00:00',
# what happens with all the values from 00:00:00 to 07:59:59 hrs?
# The following lines of code makes sure that the missing elements in a day are actually
# considered as missing
st <- paste(format(start(x), "%Y-%m-%d"), "00:00:00", tz)
et <- paste(format(end(x), "%Y-%m-%d"), "23:59:59", tz)
x <- izoo2rzoo(x, from=st, to=et, tz=tz)
# Computing the Daily time series
tmp <- aggregate(x, by= function(tt) format(tt, "%Y-%m-%d"), FUN=FUN, na.rm= na.rm, ...)
# Removing annual values in the output object for days with
# more than 'na.rm.max' percentage of NAs in a given day
if ( na.rm & (na.rm.max != 0) ) {
# Checking that 'na.rm.max' is in [0, 1]
if ( (na.rm.max <0) | (na.rm.max <0) )
stop("Invalid argument: 'na.rm.max' must be in [0, 1] !")
# Computing the percentage of missing values in each day
na.pctg <- cmv(x, tscale="daily", start=start, start.fmt=start.fmt, tz=tz)
# identifying days with a percentage of missing values higher than 'na.rm.max'
na.pctg.index <- which( na.pctg >= na.rm.max)
# Setting as NA all the days with a percentage of missing values higher than 'na.rm.max'
tmp[na.pctg.index] <- NA
} # IF end
# Removing subdaily time attibute, but not the dates
if (NCOL(tmp) == 1) {
tmp <- zoo(as.numeric(tmp), as.Date(time(tmp), format="%Y-%m-%d") )
} else tmp <- zoo::zoo(zoo::coredata(tmp), as.Date(time(tmp), format="%Y-%m-%d") )
# Replacing the NaNs by 'NA.
# mean(NA:NA, na.rm=TRUE) == NaN
nan.index <- which(is.nan(tmp))
if ( length(nan.index) > 0 ) tmp[nan.index] <- NA
# Replacing all the Inf and -Inf by NA's
# min(NA:NA, na.rm=TRUE) == Inf ; max(NA:NA, na.rm=TRUE) == -Inf
inf.index <- which(is.infinite(tmp))
if ( length(inf.index) > 0 ) tmp[inf.index] <- NA
return(tmp)
} # 'subdaily2daily.zoo' end
################################################################################
# Author : Mauricio Zambrano-Bigiarini #
################################################################################
# Started: 09-Apr-2013 #
# Updates: 18-Dec-2019 #
# 27-May-2021 #
# 23-Aug-2022 ; 11-Oct-2022 #
# 25-May-2023 ; 30-Jul-2023 ; 03-Aug-2023 #
################################################################################
# 'dates' : "numeric", "factor", "Date" indicating how to obtain the
# dates for correponding to the 'sname' station
# If 'dates' is a number, it indicates the index of the column in
# 'x' that stores the dates
# If 'dates' is a factor, it have to be converted into 'Date' class,
# using the date format specified by 'date.fmt'
# If 'dates' is already of Date class, the following line verifies that
# the number of days in 'dates' be equal to the number of element in the
# time series corresponding to the 'st.name' station
# 'date.fmt': format in which the dates are stored in 'dates'.
# ONLY required when class(dates)=="factor" or "numeric"
# 'out.fmt' : character, for selecting if the result will be 'numeric' or 'zoo'. Valid values are: c('numeric', 'zoo')
# 'verbose' : logical; if TRUE, progress messages are printed
subdaily2daily.data.frame <- function(x, FUN, na.rm=TRUE, na.rm.max=0, start="00:00:00",
start.fmt= "%H:%M:%S", tz,
dates=1, date.fmt="%Y-%m-%d %H:%M:%S",
out.fmt="zoo",
verbose=TRUE,...) {
# Checking that the user provide a valid value for 'FUN'
if (missing(FUN))
stop("Missing argument value: 'FUN' must contain a valid function for aggregating the values !!")
# Checking that the user provied a valid argument for 'out.fmt'
if (is.na(match( out.fmt, c("numeric", "zoo") ) ) )
stop("Invalid argument: 'out.fmt' must be in c('numeric', 'zoo')")
# Checking that the user provied a valid argument for 'dates'
if (missing(dates)) {
stop("Missing argument: 'dates' must be provided")
} else
# Checking that the user provied a valid argument for 'dates'
if (FALSE && (class(dates) %in% c("numeric", "factor", "POSIXct", "POSIXt")) )
stop("Invalid argument: 'dates' must be of class 'numeric', 'factor', 'POSIXct', 'POSIXt'")
# Automatic detection of 'tz'
#if (missing(tz)) tz <- ""
if (missing(tz)) tz <- format(time(x), "%Z")[1]
# If 'dates' is a number, it indicates the index of the column of 'x' that stores the dates
# The column with dates is then substracted form 'x' for easening the further computations
if ( TRUE && ( inherits(dates, "numeric") ) ) {
tmp <- dates
dates <- as.POSIXct(x[, dates], format= date.fmt, tz=tz)
x <- x[-tmp]
} # IF end
# If 'dates' is a factor, it have to be converted into 'Date' class,
# using the date format specified by 'date.fmt'
if ( TRUE && ( inherits(dates, "factor") ) ) dates <- as.POSIXct(dates, format= date.fmt, tz=tz)
# If 'dates' is already of Date class, the following line verifies that
# the number of days in 'dates' be equal to the number of element in the
# time series corresponding to the 'st.name' station
if ( (TRUE && (class(dates) %in% c("POSIXct", "POSIXt")) ) & (length(dates) != nrow(x) ) )
stop("Invalid argument: 'length(dates)' must be equal to 'nrow(x)'")
# Transforming 'x' into a zoo object
x <- zoo::zoo(x, dates)
##############################################################################
z <- subdaily2daily.zoo(x=x, FUN=FUN, na.rm=na.rm, na.rm.max=na.rm.max,
start=start, start.fmt=start.fmt, tz=tz, ...)
if (out.fmt == "numeric") {
snames <- colnames(z)
dates.lab <- as.character(time(z))
z <- zoo::coredata(z)
colnames(z) <- snames
rownames(z) <- dates.lab
} # IF end
return( z )
} #'subdaily2daily.data.frame' END
################################################################################
# Author : Mauricio Zambrano-Bigiarini #
################################################################################
# Started: 09-Apr-2013 #
# Updates: 18-Dec-2019 #
# 27-May-2021 #
# 25-May-2023 #
# 30-Jul-2023 ; 03-Aug-2023 #
################################################################################
subdaily2daily.matrix <- function(x, FUN, na.rm=TRUE, na.rm.max=0,
start="00:00:00", start.fmt= "%H:%M:%S", tz,
dates=1, date.fmt="%Y-%m-%d %H:%M:%S",
out.fmt="zoo",
verbose=TRUE,...) {
# Automatic detection of 'tz'
#if (missing(tz)) tz <- ""
if (missing(tz)) tz <- format(time(x), "%Z")[1]
x <- as.data.frame(x)
#NextMethod("daily2annual") # I don't know why is redirecting to 'daily2monthly.default' instead of 'daily2monthly.data.frame'....
subdaily2daily.data.frame(x=x, FUN=FUN, na.rm=na.rm, na.rm.max=na.rm.max,
start=start, start.fmt=start.fmt, tz=tz,
dates=dates, date.fmt=date.fmt,
out.fmt=out.fmt,
verbose=verbose,...)
} # 'subdaily2daily.matrix ' END
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.