tests/testthat/test_waterDepth.R

In hydflood: Flood Extents and Duration along the Rivers Elbe and Rhine

library(hydflood)

context("waterDepth")

test_that("waterDepth: checks", {
    
    ## x
    # x missing
    expect_error(waterDepth(value = "MQ"),
                 "The 'x' argument has to be supplied.")
    
    # x class
    expect_error(waterDepth(x = 1, value = "MQ"), 
                 "'x' must be type 'SpatRaster'")
    
    # names(x)
    y <- c(x = rast(crs = crs("EPSG:25833")),
           y = rast(crs = crs("EPSG:25833")))
    expect_error(waterDepth(x = y, value = "MQ"),
                 "'names(x)' must be 'dem' and 'csa'.", fixed = TRUE)
    
    # crs(x)
    y <- rast(c(dem = rast(crs = crs("EPSG:25831")),
                csa = rast(crs = crs("EPSG:25831"))))
    expect_error(waterDepth(x = y, value = "MQ"),
                 "The projection of x must be either", fixed = TRUE)
    
    ## value
    x <- rast(c(dem = rast(crs = crs("EPSG:25833")),
                csa = rast(crs = crs("EPSG:25833"))))
    
    # value missing
    expect_error(waterDepth(x = x),
                 "'value' must be supplied.")
    
    # class(value)
    expect_error(waterDepth(x = x, value = 1),
                 "'value' must be type 'POSIXct', 'POSIXt', 'Date' or 'charac.")
    
    # length(value)
    expect_error(waterDepth(x = x, value = c("MQ", "MNQ")),
                 "The length of 'value' must 1.")
    
    # possible character values
    expect_error(waterDepth(x = x, value = "MTnw"),
                 "The supplied 'value' must be is among the foll", fixed = TRUE)
    
    # temporal range
    expect_error(waterDepth(x = x, value = as.POSIXct("1950-12-12")),
                 "'value' must be between 1960-01-01 00:00:00 and now.",
                 fixed = TRUE)
    
    ## df
    # class(df)
    expect_error(waterDepth(x = x, value = "MQ", df = 1),
                 "'df' must be type 'data.frame'.")
    
    # class(value)
    expect_error(waterDepth(x = x, value = 1, df = data.frame()),
                 "'value' must be type 'character'.")
    
    # names(df)
    expect_error(waterDepth(x = x, value = "MQ", df = data.frame(a = 1)),
                 "\"gauging_station\" %in% names(df) is not TRUE",
                 fixed = TRUE)
    # class(df$gauging_station)
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = 1)),
                 "inherits(df$gauging_station, \"character\") is not TRUE",
                 fixed = TRUE)
    
    # names(df)
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = "test")),
                 "\"river\" %in% names(df) is not TRUE",
                 fixed = TRUE)
    # class(df$river)
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = "test",
                                            river = 1)),
                 "inherits(df$river, \"character\") is not TRUE",
                 fixed = TRUE)
    # df$river(s)
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = "test",
                                            river = "test")),
                 "all(tolower(unique(df$river)) %in% unique(",
                 fixed = TRUE)
    
    # names(df)
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = "test",
                                            river = "Elbe")),
                 "\"longitude\" %in% names(df) is not TRUE",
                 fixed = TRUE)
    # class(df$longitude)
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = "test",
                                            river = "Elbe", longitude = "a")),
                 "inherits(df$longitude, \"numeric\") | inherits(df$longitude,",
                 fixed = TRUE)
    
    # names(df)
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = "test",
                                            river = "Elbe", longitude = 1)),
                 "\"latitude\" %in% names(df) is not TRUE",
                 fixed = TRUE)
    # class(df$latitude)
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = "test",
                                            river = "Elbe", longitude = 1,
                                            latitude = "a")),
                 "inherits(df$latitude, \"numeric\") | inherits(df$latitude, ",
                 fixed = TRUE)
    
    # names(df)
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = "test",
                                            river = "Elbe", longitude = 1,
                                            latitude = 1)),
                 "\"km_csa\" %in% names(df) is not TRUE",
                 fixed = TRUE)
    # class(df$km_csa)
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = "test",
                                            river = "Elbe", longitude = 1,
                                            latitude = 1, km_csa = "1")),
                 "inherits(df$km_csa, \"numeric\") | inherits(df$km_csa, \"int",
                 fixed = TRUE)
    
    # names(df)
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = "test",
                                            river = "Elbe", longitude = 1,
                                            latitude = 1, km_csa = 1)),
                 "\"pnp\" %in% names(df) is not TRUE",
                 fixed = TRUE)
    # class(df$pnp)
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = "test",
                                            river = "Elbe", longitude = 1,
                                            latitude = 1, km_csa = 1,
                                            pnp = "0")),
                 "inherits(df$pnp, \"numeric\") | inherits(df$pnp, \"intege",
                 fixed = TRUE)
    
    # names(df)
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = "test",
                                            river = "Elbe", longitude = 1,
                                            latitude = 1, km_csa = 1, pnp = 0)),
                 "value %in% names(df) is not TRUE",
                 fixed = TRUE)
    # class(df[, value])
    expect_error(waterDepth(x = x, value = "MQ",
                            df = data.frame(gauging_station = "test",
                                            river = "Elbe", longitude = 1,
                                            latitude = 1, km_csa = 1,
                                            pnp = 0, MQ = "0")),
                 "inherits(df[, value], \"numeric\") | inheri",
                 fixed = TRUE)
    
    # filename class
    expect_error(waterDepth(x = x, value = "MQ", filename = 1),
                 "'filename' must be type 'character'.")
    
    # filename length
    expect_error(waterDepth(x = x, value = "MQ", filename = c("a", "b")), 
                 "'filename' must have length 1.")
})

test_that("waterDepth: FLYS3", {
    if (Sys.info()["nodename"] == "pvil-rr.bafg.de") {
        # Elbe
        hf <- Sys.getenv("hydflood")
        x <- hydSpatRaster(
            filename_dem = paste0(hf, "/data-raw/raster.dem.tif"),
            filename_csa = paste0(hf, "/data-raw/raster.csa.tif"))
        
        expect_no_condition(waterDepth(x = x, value = "MQ"))
        expect_no_condition(waterDepth(x = x, value = as.POSIXct("2016-12-21")))
        
        # Rhine
        hf <- Sys.getenv("hydflood")
        x <- hydSpatRaster(
            filename_dem = paste0(hf, "/data-raw/raster.dem_plittersdorf.tif"),
            filename_csa = paste0(hf, "/data-raw/raster.csa_plittersdorf.tif"))
        
        expect_no_condition(waterDepth(x = x, value = "MQ"))
        expect_no_condition(waterDepth(x = x, value = as.POSIXct("2016-12-21")))
    }
})