tests/testthat/test_hydrograph_report.R

In mpdougherty/razviz: A package to visualize performance of HEC-RAS models

context("hydrograph report")
library(razviz)
library(readr)
library(readtext)
library(stringr)

software_file <- system.file("development/HEC-DSSVue-v3.0.00.212/HEC-DSSVue-v3.0.00.212", package = "razviz")
options(dss_location=software_file)

library(rJava)
library(dssrip)

#to remove scientific notation
options(scipen=999)

path <- system.file("extdata/hydrographs", package = "razviz")
dss_observed_filename <- "razviz_ex_observed.dss"

observed_dss_file <- dssrip::opendss(paste0(path,"/", dss_observed_filename), stopIfNew = TRUE)

dss_model_filename <- "razviz_ex_model.dss"
model_dss_file <- dssrip::opendss(paste0(path,"/", dss_model_filename), stopIfNew = TRUE)

time_interval <- "6HOUR"
plan_names <- c("UMR_PHASEIV_2001MOD-EVENT","UMR_PHASEIV_2014-EVENT","UMR_PHASEIV_2019MOD-EVENT")
plan_events <- c(2001, 2014, 2019)


filelist = list.files(path, pattern="*.txt")

textfiles <- readtext::readtext(paste0(path,"/*.txt"), docvarsfrom = "filepaths")

for(i in 1:length(plan_events)){
  assign(paste0("UnsteadyFlowFile_",plan_events[i]),textfiles$text[i])
}

unsteadyflowfile_list <- mget(ls(pattern="UnsteadyFlowFile_"))

Formatted_UnsteadyFlowFileList <- razviz::import_hecras_unsteadyflowfiles(
  unsteadyflowfile_list = unsteadyflowfile_list,
  plan_events = plan_events)

list_observed_data <- razviz::import_observed_data(observed_dss_file = observed_dss_file,
  plan_events = plan_events,
  Formatted_UnsteadyFlowFileList = Formatted_UnsteadyFlowFileList)



list_1Dmodel_data <- razviz::import_hecras_1Dmodel_data(model_dss_file = model_dss_file,
  plan_names = plan_names,
  plan_events = plan_events,
  time_interval = time_interval,
  Formatted_UnsteadyFlowFileList = Formatted_UnsteadyFlowFileList)



SA2D_CONNECTIONS <- read.csv(paste0(path,"/UMR_2DFLOWAREAS.csv"))

#Clean up data frame so that only 2D areas that have cross sections associated are kept.
SA2D_CONNECTIONS <- SA2D_CONNECTIONS[!(is.na(SA2D_CONNECTIONS$CX_RM) | SA2D_CONNECTIONS$CX_RM==""), ]

list_2Dmodel_data <- razviz::import_hecras_2Dmodel_data(model_dss_file = model_dss_file,
  plan_names = plan_names,
  plan_events = plan_events,
  time_interval = time_interval,
  Formatted_UnsteadyFlowFileList = Formatted_UnsteadyFlowFileList,
  SA2D_CONNECTIONS = SA2D_CONNECTIONS)


#Identify if modeled data is a calibration run or final model
run_type <- "Calibration"
#Identify which calibration run it is
run_number <- 1

#Make a list of river miles where there are gage locations in the RAS model
Formatted_UnsteadyFlowFile <- Formatted_UnsteadyFlowFileList[[1]]
locations <- unique(Formatted_UnsteadyFlowFile$RiverMile)

hydrograph_datatables <- razviz::hydrograph_datatables(list_observed_data = list_observed_data,
                                                       list_1Dmodel_data = list_1Dmodel_data,
                                                       list_2Dmodel_data = list_2Dmodel_data,
                                                       locations = locations,
                                                       plan_events = plan_events,
                                                       run_type = run_type,
                                                        run_number = run_number)

#combine and reformat datatable
hydrograph_df_wide <- razviz::combine_hydrographs(hydrograph_datatables) #wide version

# Convert to long format suitable for plotting
hydrograph_df <- razviz::lengthen_hydrographs(hydrograph_df_wide) #long version

#remove missing values
hydrograph_df_na <- hydrograph_df[!is.na(hydrograph_df$value),]

#rename the levels to what will be shown on plots.
hydrograph_df_na$Event <- factor(hydrograph_df_na$Event, levels = c("2001","2014","2019"),
  labels = c("2001MOD","2014","2019MOD") )

#assign the group of data a run number and type
hydrograph_df_na$Run_num <- 1
hydrograph_df_na$Run_type <- "Calibration"


# Create a hydrograph report
output_dir <- tempdir()

filename <- "Hydrograph_Plot_Report.pdf"

#Define hydrograph plot pages
hg_plot_pages <- razviz::hydrograph_plot_pages(hydrograph_df_na)


# Create hydrograph report
razviz::hydrograph_report(hydrograph_df = hydrograph_df_na,
                          hg_plot_pages = hg_plot_pages,
                          output_dir = output_dir, filename = filename)


test_that("hydrograph report", {
  expect_true(file.exists(file.path(output_dir,
                                    "Hydrograph_Plot_Report.pdf")))
})