tests/testthat/test-add_legend_title.R

In ggsurvfit: Flexible Time-to-Event Figures

test_that("add_legend_title() works", {
  # title is placed for typical usage
  expect_error(
    sf1 <-
      survfit2(Surv(time, status) ~ surg, data = df_colon) %>%
      ggsurvfit() +
      add_legend_title(),
    NA
  )
  expect_equal(
    suppressWarnings(ggplot2::ggplot_build(sf1))$plot$labels$colour,
    "Time from Surgery to Treatment"
  )

  # title is placed with CI as well
  expect_error(
    sf2 <-
      survfit2(Surv(time, status) ~ surg, data = df_colon) %>%
      ggsurvfit() +
      add_confidence_interval() +
      add_censor_mark() +
      add_legend_title(),
    NA
  )
  expect_equal(
    suppressWarnings(ggplot2::ggplot_build(sf2))$plot$labels$colour,
    "Time from Surgery to Treatment"
  )
  expect_equal(
    suppressWarnings(ggplot2::ggplot_build(sf2))$plot$labels$fill,
    "Time from Surgery to Treatment"
  )

  # title is placed with linetype correctly
  expect_error(
    sf3 <-
      survfit2(Surv(time, status) ~ surg, data = df_colon) %>%
      ggsurvfit(linetype_aes = TRUE) +
      add_confidence_interval() +
      add_censor_mark() +
      add_legend_title(),
    NA
  )
  expect_equal(
    suppressWarnings(ggplot2::ggplot_build(sf3))$plot$labels$colour,
    "Time from Surgery to Treatment"
  )
  expect_equal(
    suppressWarnings(ggplot2::ggplot_build(sf3))$plot$labels$fill,
    "Time from Surgery to Treatment"
  )
  expect_equal(
    suppressWarnings(ggplot2::ggplot_build(sf3))$plot$labels$linetype,
    "Time from Surgery to Treatment"
  )

  # linetype NOT added for ggcuminc with multiple outcomes
  expect_error(
    cuminc1 <-
      tidycmprsk::cuminc(Surv(ttdeath, death_cr) ~ trt, tidycmprsk::trial) %>%
      ggcuminc(outcome = c("death from cancer", "death other causes")) +
      add_confidence_interval() +
      add_risktable() +
      add_legend_title(),
    NA
  )
  expect_equal(
    suppressWarnings(
      ggplot2::ggplot_build(cuminc1)$plot$labels$colour
    ),
    "Chemotherapy Treatment"
  )
  expect_equal(
    suppressWarnings(ggplot2::ggplot_build(cuminc1))$plot$labels$fill,
    "Chemotherapy Treatment"
  )
  expect_equal(
    suppressWarnings(ggplot2::ggplot_build(cuminc1))$plot$labels$linetype,
    NULL
  )

  expect_error(
    survfit2(Surv(time, status) ~ surg, data = df_colon) %>%
      ggsurvfit() +
      add_legend_title(title = "MY CUSTOM TITLE"),
    NA
  )

  # when no variable label present, the title is the variable name
  expect_equal(
    suppressWarnings(ggplot2::ggplot_build(
      survfit2(Surv(mpg, am) ~ cyl, data = mtcars) %>%
        ggsurvfit() +
        add_legend_title()
    ))$plot$labels$colour,
    "cyl"
  )
})