context("split method for SoilProfileCollection objects")

## sample data
data(sp6)
depths(sp6) <- id ~ top + bottom

# fake grouping var
sp6$g <- factor(rep(c('A', 'B'), each = 3))

## tests

test_that("site-level grouping factor", {
  
  # standard, grouping factor
  s <- split(sp6, 'g')
  
  # result should be a list
  expect_true(inherits(s, 'list'))
  
  # expected groups
  expect_true(length(s) == 2)
  expect_equal(names(s), levels(sp6$g))
  
  # three profiles / group
  expect_equivalent(sapply(s, length), c(3, 3))
  
})

test_that("site-level grouping factor, as a vector", {
  
  # standard, grouping factor
  s <- split(sp6, sp6$g)
  
  # result should be a list
  expect_true(inherits(s, 'list'))
  
  # expected groups
  expect_true(length(s) == 2)
  expect_equal(names(s), levels(sp6$g))
  
  # three profiles / group
  expect_equivalent(sapply(s, length), c(3, 3))
  
})

test_that("identity split", {
  
  # idname used
  # s1 <- split(sp6) # doesn't work due to base generic
  s2 <- split(sp6, idname(sp6))
  s3 <- split(sp6, profile_id(sp6))
  s4 <- split(sp6, f = NULL)
  
  # result should be a list
  # expect_true(inherits(s1, 'list'))
  expect_true(inherits(s2, 'list'))
  expect_true(inherits(s3, 'list'))
  expect_true(inherits(s4, 'list'))

  # as many groups as profiles in original
  # expect_true(length(s1) == length(s2))
  expect_true(length(s2) == length(s3))
  expect_true(length(s3) == length(s4))
  expect_true(length(s4) == length(sp6))
  
  # 1 profile / group
  expect_equivalent(sapply(s2, length), rep(1, times = length(sp6)))
})


## errors
test_that("split fails as expected", {
  
  # group variable that is not site-level attribute
  expect_error(split(sp6, f = 'XXX'))
})

test_that("split with NA values in `f`", {
  
  site(sp6)$grp1 <- c(1, 1, 2, 2, NA, NA)
  site(sp6)$grp2 <- c(1, 2, 1, 2,  1,  2)
  site(sp6)$grp3 <- rep(NA_character_, times = length(sp6))
  
  # profiles with NA are dropped
  x <- split(sp6, sp6$grp1)
  # two groups
  expect_equal(length(x), 2)
  # 4/6 profiles remain
  expect_equal(sum(sapply(x, length)), 4)
  
  
  # additional "<missing>" group (with drop=FALSE)
  x <- split(sp6, "grp1", drop = FALSE)
  # three groups
  expect_equal(length(x), 3)
  # check for special NA group
  expect_true('<missing>' %in% names(x))
  # all groups have 2 members
  expect_true(all(sapply(x, length) == 2))
  
  # interaction grp1*grp2
  x <- split(sp6, list(sp6$grp1, sp6$grp2))
  expect_equal(length(x), 4)
  
  # interaction grp1*grp2 (with drop=FALSE)
  x <- split(sp6, list(sp6$grp1, sp6$grp2), drop = FALSE)
  expect_equal(length(x), 6)
  
  ## all NA, not sure why this would happen...
  
  # all NA, empty list is the result
  x <- split(sp6, 'grp3', drop = TRUE)
  expect_true(inherits(x, 'list'))
  expect_equal(length(x), 0)
  
  # single <missing> group 
  x <- split(sp6, 'grp3', drop = FALSE)
  expect_equal(names(x), '<missing>')
  expect_equal(as.vector(sapply(x, length)), 6)
  
})