fix 2 tests out of 3; TODO: test forecasters
[talweg.git] / pkg / tests / testthat / test.computeFilaments.R
index 9de6274..15b41b7 100644 (file)
-#TODO: toy dataset, check that indices returned are correct + colors
+context("Check that computeFilaments behaves as expected")
 
-context("Check that getParamsDirs behaves as expected")
+#MOCK data; NOTE: could be in inst/testdata as well
+getDataTest = function(n, shift)
+{
+       x = seq(0,10,0.1)
+       L = length(x)
+       s1 = cos(x)
+       s2 = sin(x)
+       s3 = c( s1[1:(L%/%2)] , s2[(L%/%2+1):L] )
+       #sum((s1-s2)^2) == 97.59381
+       #sum((s1-s3)^2) == 57.03051
+       #sum((s2-s3)^2) == 40.5633
+       s = list( s1, s2, s3 )
+       series = list()
+       for (i in seq_len(n))
+       {
+               index = (i-1) %% 3 + 1 #map 1->1, 2->2, 3->3, 4->1, ..., 149->2, 150->3
+               level = mean(s[[index]])
+               serie = s[[index]] - level + rnorm(L,sd=0.01)
+               # 10 series with NAs for index 2
+               if (index == 2 && i >= 60 && i<= 90)
+                       serie[sample(seq_len(L),1)] = NA
+               series[[i]] = list("level"=level,"serie"=serie) #no need for more
+       }
+       if (shift)
+       {
+               # Simulate shift at origin when predict_at > 0
+               series[2:(n+1)] = series[1:n]
+               series[[1]] = list("level"=0, "serie"=s[[1]][1:(L%/%2)])
+       }
+       new("Data", data=series)
+}
 
-test_that("on input of sufficient size, beta is estimated accurately enough", {
-       n = 100000
-       d = 2
-       K = 2
-       Pr = c(0.5, 0.5)
+test_that("output is as expected on simulated series, predict_at == 0",
+{
+       data = getDataTest(150, shift=FALSE)
 
-       betas_ref = array( c(1,0,0,1 , 1,-2,3,1), dim=c(2,2,2) )
-       for (i in 1:(dim(betas_ref)[3]))
+       # index 143 : serie type 2
+       f = computeFilaments(data, 143, limit=60, plot=FALSE)
+       # Expected output: 23 series of type 3 (closer), then 50-3-10 series of type 2, then index 143
+       expect_identical(length(f$indices), as.integer(61)) #61 because result also contain "today"
+       expect_identical(length(f$colors),  as.integer(61))
+       for (i in 1:23)
        {
-               beta_ref = betas_ref[,,i]
-               #all parameters are supposed to be of norm 1: thus, normalize beta_ref
-               norm2 = sqrt(colSums(beta_ref^2))
-               beta_ref = beta_ref / norm2[col(beta_ref)]
+               expect_equal((f$indices[i]-1) %% 3 + 1, 3)
+               expect_match(f$colors[i], f$colors[1])
+       }
+       for (i in 24:60)
+       {
+               expect_equal((f$indices[i]-1) %% 3 + 1, 2)
+               expect_match(f$colors[i], f$colors[24])
+       }
+       expect_equal(f$indices[61], 143)
+       expect_match(f$colors[61], "#FF0000") #special color: current day in red
+       expect_match(f$colors[1], "#E*")
+       expect_match(f$colors[24], "#1*")
+})
 
-               io = generateSampleIO(n, d, K, Pr, beta_ref)
-               beta = getParamsDirs(io$X, io$Y, K)
-               betas = .labelSwitchingAlign(
-                       array( c(beta_ref,beta), dim=c(d,K,2) ), compare_to="first", ls_mode="exact")
+test_that("output is as expected on simulated series, predict_at > 0",
+{
+       data = getDataTest(150, shift=TRUE)
 
-               #Some traces: 0 is not well estimated, but others are OK
-               cat("\n\nReference parameter matrix:\n")
-               print(beta_ref)
-               cat("Estimated parameter matrix:\n")
-               print(betas[,,2])
-               cat("Difference norm (Matrix norm ||.||_1, max. abs. sum on a column)\n")
-               diff_norm = norm(beta_ref - betas[,,2])
-               cat(diff_norm,"\n")
+       # index 142 : serie type 3
+       f = computeFilaments(data, 142, limit=70, plot=FALSE)
+       # Expected output: 24 series of type 2 (closer) then 50-4 series of type 3, then 142
+       expect_identical(length(f$indices), as.integer(71))
+       expect_identical(length(f$colors), as.integer(71))
+       expect_true(all(f$indices >= 2)) #no type-1 neighbors
+       for (i in 1:24)
+       {
+               # -1 + -1 because of the initial shift
+               expect_equal((f$indices[i]-2) %% 3 + 1, 2)
+               expect_match(f$colors[i], f$colors[1])
+       }
+       for (i in 25:70)
+       {
+               expect_equal((f$indices[i]-2) %% 3 + 1, 3)
+               expect_match(f$colors[i], f$colors[25])
+       }
+       expect_equal(f$indices[71], 142)
+       expect_match(f$colors[71], "#FF0000")
+       expect_match(f$colors[1], "#E*")
+       expect_match(f$colors[25], "#1*")
+})
 
-               #NOTE: 0.5 is loose threshold, but values around 0.3 are expected...
-               expect_that( diff_norm, is_less_than(0.5) )
+test_that("output is as expected on simulated series",
+{
+       data = getDataTest(150, shift=TRUE)
+
+       # index 143 : serie type 1
+       f = computeFilaments(data, 143, limit=60, plot=FALSE)
+       # Expected output: 23 series of type 3 (closer), then 50-10-3 series of type 1, then 143
+       # NOTE: -10 because only past days with no-NAs tomorrow => exclude type 1 in [60,90[
+       expect_identical(length(f$indices), as.integer(61))
+       expect_identical(length(f$colors), as.integer(61))
+       expect_true(all(f$indices >= 2)) #first_day should be 2
+       for (i in 1:23)
+       {
+               expect_equal(( (f$indices[i]-2) %% 3 ) + 1, 3)
+               expect_match(f$colors[i], f$colors[1])
+       }
+       for (i in 24:60)
+       {
+               expect_equal(( (f$indices[i]-2) %% 3 ) + 1, 1)
+               expect_match(f$colors[i], f$colors[24])
        }
+       expect_equal(f$indices[61], 143)
+       expect_match(f$colors[61], "#FF0000")
+       expect_match(f$colors[1], "#E*")
+       expect_match(f$colors[24], "#1*")
 })