R/HUCTS_aggregator.R

In jread-usgs/HUCAgg: Functions to aggregate WBD HUC12s

#' Aggregate HUC time series data
#' 
#' Aggregate time series data for a collection of HUCs
#' 
#' @param upstream_size Named integer list of the number of upstream HUCs for each huc.
#' @param fromHUC Named list of lists containing the HUCs that flow into each HUC.
#' @param huc12_areaDF Data frame with a single observation of area for each local HUC.
#' @param huc12agg_areaDF Data fame with a single observation of area for each aggregated HUC.
#' @param dataF Data Frame with a set of observations for each local HUC.
#' @return dataF Data Frame with the set of observations aggregated upstream using a weighted average.
#' @author David Blodgett \email{dblodgett@@usgs.gov}
#' @export
#' @examples
#' \dontrun{
#' load(system.file("extdata","HUCTS_aggregator_test.rda",package="HUCAgg"))
#' outData<-HUCTS_aggregator(upstream_size,fromHUC,huc12_areaDF,huc12agg_areaDF,dataF)
#' }
HUCTS_aggregator<-function(upstream_size,fromHUC,huc12_areaDF,huc12agg_areaDF,dataF) {
    for ( setSize in 1:max(upstream_size) ) {
      hucs<-names(upstream_size[which(upstream_size==setSize)])
      if ( length(hucs) > 100 ) {
        print(setSize)
        print(paste('length of set is',length(hucs)))
      }
      for ( huc in hucs ) {
        if(huc %in% names(dataF)) {
          fromHUCs<-fromHUC[huc]
          # calculate the sum of areas
          area<-huc12_areaDF[huc][[1]]
          # Set wa to the local times its area initially.
          wa<-dataF[huc][[1]]*huc12_areaDF[huc][[1]]
          for(h in unlist(fromHUCs[[1]])) {
            try({
              # Loop over the fromHUCs adding them to wa with their area.
              wa<-wa+dataF[h][[1]]*huc12agg_areaDF[h][[1]]
              area<-area+huc12agg_areaDF[h][[1]]}, silent = TRUE
            )
          }
          wa<-wa/area
        }
        dataF[huc]<-wa
      }
    }
    return(dataF)
  }