tests/testthat/test_xs_dimensions.R

In FluvialGeomorph/fluvgeo: A Package for Fluvial Geomorphic Analysis

library(fluvgeo)
context("xs_dimension")

# Extract attribute data from sf object
sin_xs_points_df <- fluvgeo::sin_riffle_channel_points_sf

# Call the xs_dimensions function with test data
streams <- c("Sinsinawa")
regions <- c("Eastern United States", "IN Central Till Plain")
bankfull_elevations <- seq(103, 104, 0.1)

sin <- xs_dimensions(xs_points = sin_xs_points_df,
                     streams = streams,
                     regions = regions,
                     bankfull_elevations = bankfull_elevations)

test_that("Check parameters", {
  expect_error(xs_dimensions(10, "Sinsinawa", 4, 103.5),
               info = "xs_points not a dataframe")
  expect_error(xs_dimensions(sin_xs_points_df[,-2], "Sinsinawa",
                             regions, bankfull_elevations),
               info = "xs_points is missing the Seq field")
  expect_error(xs_dimensions(sin_xs_points_df[,-3], "Sinsinawa",
                             regions, bankfull_elevations),
               info = "xs_points is missing the POINT_X field")
  expect_error(xs_dimensions(sin_xs_points_df[,-4], "Sinsinawa",
                             regions, bankfull_elevations),
               info = "xs_points is missing the POINT_Y field")
  expect_error(xs_dimensions(sin_xs_points_df[,-5], "Sinsinawa",
                             regions, bankfull_elevations),
               info = "xs_points is missing the POINT_M field")
  expect_error(xs_dimensions(sin_xs_points_df[,-6], "Sinsinawa",
                             regions, bankfull_elevations),
               info = "xs_points is missing the Watershed_Area_SqMile field")
  expect_error(xs_dimensions(sin_xs_points_df[,-7], "Sinsinawa",
                             regions, bankfull_elevations),
               info = "xs_points is missing the km_to_mouth field")
  expect_error(xs_dimensions(sin_xs_points_df[,-8], "Sinsinawa",
                             regions, bankfull_elevations),
               info = "xs_points is missing the DEM_Z field")
  expect_error(xs_dimensions(sin_xs_points_df[,-9], "Sinsinawa",
                             regions, bankfull_elevations),
               info = "xs_points is missing the Detrend_DEM_Z field")
  expect_error(xs_dimensions(sin_xs_points_df[,-10], "Sinsinawa",
                                   regions, bankfull_elevations),
               info = "xs_points is missing the ReachName field")
  expect_error(xs_dimensions(sin_xs_points_df, 8,
                             regions, bankfull_elevations),
               info = "streams is not a character vector")
  expect_error(xs_dimensions(sin_xs_points_df, streams,
                             8, bankfull_elevations),
               info = "regions is not a character vector")
  expect_error(xs_dimensions(sin_xs_points_df, streams,
                             regions, "a"),
               info = "bankfull_elevations is not a numeric vector")
})

test_that("Check that fields exist by name", {
  expect_true("reach_name"            %in% colnames(sin))
  expect_true("cross_section"         %in% colnames(sin))
  expect_true("xs_type"               %in% colnames(sin))
  expect_true("bankfull_elevation"    %in% colnames(sin))
  expect_true("drainage_area"         %in% colnames(sin))
  expect_true("xs_area"               %in% colnames(sin))
  expect_true("xs_width"              %in% colnames(sin))
  expect_true("xs_depth"              %in% colnames(sin))
  expect_true("discharge"             %in% colnames(sin))
})

test_that("Check that fields are of the correct data type", {
  expect_true(is.character(sin$reach_name))
  expect_true(is.numeric(sin$cross_section))
  expect_true(is.character(sin$xs_type))
  expect_true(is.numeric(sin$bankfull_elevation))
  expect_true(is.numeric(sin$drainage_area))
  expect_true(is.numeric(sin$xs_area))
  expect_true(is.numeric(sin$xs_width))
  expect_true(is.numeric(sin$xs_depth))
  expect_true(is.numeric(sin$discharge))
})

test_that("Check output dimensionality", {
  expect_equal(length(unique(sin$reach_name)),            1,
               label = "number of reaches")
  expect_equal(length(unique(sin$cross_section)),         10,
               label = "number of cross sections")
  expect_equal(length(unique(sin$xs_type)),               3,
               label = "number of xs types")
  expect_equal(length(unique(sin$bankfull_elevation)),    11,
               label = "number of bankfull elevations")
  expect_equal(length(unique(sin$drainage_area)),         10,
               label = "number of drainage areas")
})