test-branch.R
In mverse: Tidy Multiverse Analysis Made Simple

test_that("Branches require at least one rule.", {
  expect_error(
    mutate_branch(),
    "Error: Provide at least one rule."
  )
  expect_error(
    filter_branch(),
    "Error: Provide at least one rule."
  )
})

test_that("*_branch() defines branches without 'name'.", {
  expect_equal(
    rlang::quo_name(mutate_branch(x + y)$opts[[1]]), "x + y"
  )
  expect_equal(
    rlang::quo_name(filter_branch(x > 0)$opts[[1]]), "x > 0"
  )
})

test_that("*_branch() defines branches with names specified.", {
  expect_equal(mutate_branch(x + y, name = "xnew")$name, "xnew")
  expect_equal(filter_branch(x + y, name = "xnew")$name, "xnew")
})

test_that("*_branch() checks a provided name is a character.", {
  expect_error(
    mutate_branch(x + y, name = 0),
    'Error: "name" must be a character object.'
  )
  expect_error(
    filter_branch(x > 0, name = 0.5),
    'Error: "name" must be a character object.'
  )
})

test_that("*_brach() defines branches with multiple options.", {
  mbranch <- mutate_branch(x + y, x - y, x * y)
  expect_equal(
    rlang::quo_name(mbranch$opts[[1]]), "x + y"
  )
  expect_equal(
    rlang::quo_name(mbranch$opts[[2]]), "x - y"
  )
  expect_equal(
    rlang::quo_name(mbranch$opts[[3]]), "x * y"
  )
  expect_equal(length(mbranch$opts), 3)
  fbranch <- filter_branch(x > 0, x < 0, x == 0)
  expect_equal(
    rlang::quo_name(fbranch$opts[[1]]), "x > 0"
  )
  expect_equal(
    rlang::quo_name(fbranch$opts[[2]]), "x < 0"
  )
  expect_equal(
    rlang::quo_name(fbranch$opts[[3]]), "x == 0"
  )
  expect_equal(length(fbranch$opts), 3)
})

test_that("name() extracts the name of a branch.", {
  mbranch <- mutate_branch(x + y, x - y, x * y, name = "mutate")
  expect_equal(mverse:::name.branch(mbranch), "mutate")
  fbranch <- filter_branch(x > 0, x < 0, x == 0, name = "filter")
  expect_equal(mverse:::name.branch(fbranch), "filter")
  frmbranch <- formula_branch(y ~ x, y ~ log(x), name = "formula")
  expect_equal(mverse:::name.branch(frmbranch), "formula")
  fambranch <- family_branch(poisson, gaussian(link = "log"), name = "family")
  expect_equal(mverse:::name.branch(fambranch), "family")
})

test_that("name() renames a branch.", {
  mbranch <- mutate_branch(x + y, x - y, x * y, name = "mutate")
  mbranch <- mverse:::name.branch(mbranch, "mrename")
  expect_equal(mverse:::name.branch(mbranch), "mrename")
  fbranch <- filter_branch(x > 0, x < 0, x == 0, name = "filter")
  fbranch <- mverse:::name.branch(fbranch, "frename")
  expect_equal(mverse:::name.branch(fbranch), "frename")
})

test_that("*_branch() creates a branching command for multiverse.", {
  mbranch <- mutate_branch(x + y, x - y, x * y, name = "m")
  expect_equal(
    mverse:::parse.branch(mbranch),
    rlang::parse_expr(
      'branch(m_branch, "m_1" ~ x + y, "m_2" ~ x - y, "m_3" ~ x * y)'
    )
  )
  fbranch <- filter_branch(x > 0, x < 0, x == 0, name = "f")
  expect_equal(
    mverse:::parse.branch(fbranch),
    rlang::parse_expr(
      'branch(f_branch, "f_1" ~ x > 0, "f_2" ~ x < 0, "f_3" ~ x == 0)'
    )
  )
})

test_that("parse() handles named branched options", {
  mbranch <- mutate_branch(
    add = x + y, subtract = x - y, multiply = x * y, name = "m"
  )
  expect_equal(
    mverse:::parse.branch(mbranch),
    rlang::parse_expr(
      'branch(m_branch, "add" ~ x + y, "subtract" ~ x - y, "multiply" ~ x * y)'
    )
  )
  fbranch <- filter_branch(x > 0, x < 0, equals = x == 0, name = "filter")
  expect_equal(
    mverse:::parse.branch(fbranch),
    rlang::parse_expr(
      paste0('branch(filter_branch, "filter_1" ~ x > 0, ',
             '"filter_2" ~ x < 0, "equals" ~ x == 0)')
    )
  )
  frml <- formula_branch(linear = x ~ y, x ~ z, name = "model")
  expect_equal(
    mverse:::parse.branch(frml),
    rlang::parse_expr(
      'branch(model_branch, "linear" ~ x ~ y, "model_2" ~ x ~ z)'
    )
  )
  fmly <- family_branch(linear = gaussian, name = "fam")
  expect_equal(
    mverse:::parse.branch(fmly),
    rlang::parse_expr(
      'branch(fam_branch, "linear" ~ gaussian)'
    )
  )
})

test_that("parse() handles long branch options.", {
  mydf <- data.frame(col1 = c(1, 2, 3))
  mbranch <- mutate_branch(
    ifelse(col1 > 1, "a", ifelse(col1 == 1, "b", "c"))
  )
  mv <- mverse(mydf) %>%
    add_mutate_branch(mbranch) %>%
    execute_multiverse()
  parsed_branches <- sapply(attr(mv, "branches_list"), mverse:::parse.branch)
  expect_true(any(
    grepl("mbranch_1", parsed_branches)
  ))
  expect_true(any(
    grepl("ifelse\\(col1 > 1", parsed_branches)
  ))
  fbranch <- formula_branch(
    cbind(col1, col2 - col1) ~ col3 + col3^2 + col3^3 +
      col3^4 + exp(col3 + col3^2),
    cbind(col1, col2 - col1) ~ col3 + col3^2 + col3^3 +
      col3^4 + exp(col3) + exp(col3^2)
  )
  add_formula_branch(mv, fbranch) |>
    execute_multiverse()
  parsed_branches <- sapply(attr(mv, "branches_list"), mverse:::parse.branch)
  expect_true(any(
    grepl("fbranch_2", parsed_branches)
  ))
  expect_true(any(
    grepl("cbind\\(col1, col2 - col1", parsed_branches)
  ))
})

test_that("add_*_branch() adds a branch.", {
  mydf <- data.frame(
    x = c(1, 2, 3),
    y = c(4, 5, 6)
  )
  mv <- mverse(mydf)
  mbranch <- mutate_branch(x + y, x - y, x * y, name = "m")
  fbranch <- filter_branch(x > 0, x < 0, x == 0, name = "f")
  mv %>%
    add_mutate_branch(mbranch) %>%
    add_filter_branch(fbranch)
  expect_equal(attr(mv, "branches_list")[[1]]$name, "m")
  expect_equal(attr(mv, "branches_list")[[2]]$name, "f")
})

test_that("add_*_branch() adds multiple branches in order.", {
  mydf <- data.frame(
    x = c(1, 2, 3),
    y = c(4, 5, 6)
  )
  mv <- mverse(mydf)
  mv %>%
    add_mutate_branch(
      mutate_branch(x + y, x - y, x * y, name = "m1"),
      mutate_branch(x + y, x - y, x * y, name = "m2")
    ) %>%
    add_filter_branch(
      filter_branch(x > 0, x < 0, x == 0, name = "f1"),
      filter_branch(x > 0, x < 0, x == 0, name = "f2")
    )
  nms <- sapply(attr(mv, "branches_list"), function(x) x$name)
  expect_equal(nms, c("m1", "m2", "f1", "f2"))
})

test_that("add_*_branch() checks for a new variable name.", {
  mydf <- data.frame(
    x = c(1, 2, 3),
    y = c(4, 5, 6)
  )
  mverse <- create_multiverse(mydf)
  expect_error(
    mverse %>% add_mutate_branch(
      mutate_branch(x + y)
    ),
    "Please specify a variable name for the branch rule:.*"
  )
  expect_error(
    mverse %>% add_filter_branch(
      filter_branch(x > 0, x < 0, x == 0)
    ),
    "Please specify a variable name for the branch rule:.*"
  )
})

test_that(
  "formula_branch() with covariates option creates covariate branches linked
  with the formula branch.", {
    mydf <- data.frame(
      x = c(1, 2, 3),
      y = c(4, 5, 6),
      w = c(7, 8, 9),
      z = c(10, 11, 12)
    )
    mv <- create_multiverse(mydf)
    frml <- formula_branch(y ~ x, y ~ log(x),
                           covariates = c("z", "w"))
    expect_equal(frml$covariates, c("z", "w"))
    frml <- formula_branch(y ~ x,
                           covariates = c("z", "w"),
                           name = "f")
    expect_equal(frml$covariates, c("z", "w"))
    add_formula_branch(mv, frml)
    branch_names <- names(multiverse::parameters(mv))
    expect_true(any(grepl("covariate_z_branch", branch_names)))
    expect_true(any(grepl("covariate_w_branch", branch_names)))
    expect_equal(nrow(summary(mv)), 4)
    expect_contains(summary(mv)[["covariate_z_branch"]],
                    c("include_z", "exclude_z"))
    expect_contains(summary(mv)[["covariate_w_branch"]],
                    c("include_w", "exclude_w"))
  }
)