tests/testthat/test-indexing.R

In EarthSystemDiagnostics/pfields: An R Package to Analyse Gridded Field Data

context("test-indexing")

test_that("pField indexing works correctly.", {

  # Create a pField
  lat <- c(-75, -80)
  lon <- c(0, 135, 215)
  time <- 1 : 4
  space <- c(1, 1, 1, 2, 2, 2)
  spacetime <- c(space, 10 * space, 100 * space, 1000 * space)

  pfield <- pField(data = spacetime, lat = lat, lon = lon, time = time)

  # Test single indexing

  expect_error(subset <- pfield[1, ], NA)
  expect_true(is.pField(subset))
  expect_equal(dim(subset), c(1, 6))

  expect_error(subset <- subset[, 1 : 4], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), c(1, 4))

  expect_error(subset <- pfield[, 1], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), NULL)

  expect_warning(subset <- pfield[10])
  expect_equal(c(subset), 10)

  expect_error(subset <- pfield[1, 1], NA)
  expect_true(is.pTs(subset))
  expect_equal(unname(c(subset)), 1)

  # Test 1D vector indexing

  expect_warning(subset <- pfield[1 : 10])

  expect_error(subset <- pfield[1 : 3, ], NA)
  expect_true(is.pField(subset))

  expect_error(subset <- pfield[, 1 : 3], NA)
  expect_true(is.pField(subset))

  expect_error(subset <- pfield[, 1 : 4], NA)
  expect_true(is.pTs(subset))

  # Test indexing by one vector and one integer

  expect_error(subset <- pfield[1, 1 : 3], NA)
  expect_true(is.pField(subset))
  expect_equal(dim(subset), c(1, 3))

  expect_error(subset <- pfield[1, 1 : 4], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), c(1, 4))

  expect_error(subset <- pfield[1 : 3, 1], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), NULL)

  # Test 2D vector indexing

  expect_error(subset <- pfield[1 : 3, 1 : 3], NA)
  expect_true(is.pField(subset))

  expect_error(subset <- pfield[1 : 3, 1 : 5], NA)
  expect_true(is.pTs(subset))

})

test_that("pTs indexing works correctly for single-site pTs.", {

  # Create a pTs object with 10 data sets from the same site
  dat <- matrix(rnorm(10 * 100), nrow = 100, ncol = 10)
  pts <- pTs(dat, lat = -75, lon = 0,
             name = "10 proxy time series.")

  # Test single indexing

  expect_error(subset <- pts[1, ], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), c(1, 10))

  expect_error(subset <- subset[, 1 : 5], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), c(1, 5))

  expect_error(subset <- pts[, 1], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), NULL)

  expect_warning(subset <- pts[10])

  expect_error(subset <- pts[1, 1], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), NULL)

  # Test 1D vector indexing

  expect_warning(subset <- pts[1 : 10])

  expect_error(subset <- pts[1 : 3, ], NA)
  expect_true(is.pTs(subset))

  expect_error(subset <- pts[, 1 : 3], NA)
  expect_true(is.pTs(subset))

  # Test indexing by one vector and one integer

  expect_error(subset <- pts[1, 1 : 3], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), c(1, 3))

  expect_error(subset <- pts[1 : 3, 1], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), NULL)

  # Test 2D vector indexing

  expect_error(subset <- pts[1 : 3, 1 : 3], NA)
  expect_true(is.pTs(subset))

})

test_that("pTs indexing works correctly for multi-site pTs.", {

  # Create a pTs object with 10 data sets from the same site
  dat <- matrix(rnorm(10 * 100), nrow = 100, ncol = 10)
  lat <- seq(-75, -85, length.out = 10)
  lon <- seq(0, 90, length.out = 10)
  pts <- pTs(dat, lat = lat, lon = lon,
             name = "Proxy time series from 10 sites.")

  # Test single indexing

  expect_error(subset <- pts[1, ], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), c(1, 10))

  expect_error(subset <- subset[, 1 : 5], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), c(1, 5))

  expect_error(subset <- pts[, 1], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), NULL)

  expect_warning(subset <- pts[10])

  expect_error(subset <- pts[1, 1], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), NULL)

  # Test 1D vector indexing

  expect_warning(subset <- pts[1 : 10])

  expect_error(subset <- pts[1 : 3, ], NA)
  expect_true(is.pTs(subset))

  expect_error(subset <- pts[, 1 : 3], NA)
  expect_true(is.pTs(subset))

  # Test indexing by one vector and one integer

  expect_error(subset <- pts[1, 1 : 3], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), c(1, 3))

  expect_error(subset <- pts[1 : 3, 1], NA)
  expect_true(is.pTs(subset))
  expect_equal(dim(subset), NULL)

  # Test 2D vector indexing

  expect_error(subset <- pts[1 : 3, 1 : 3], NA)
  expect_true(is.pTs(subset))

})