Even more nonsense (pharmaverse#183)

* progress

* Update test-coverage.yaml

* Update test-coverage.yaml

Author: ddsjoberg

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: ggsurvfit
 Title: Flexible Time-to-Event Figures
-Version: 0.3.1.9003
+Version: 0.3.1.9004
 Authors@R: c(
     person("Daniel D.", "Sjoberg", , "[email protected]", role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0000-0003-0862-2018")),

NEWS.md

@@ -1,6 +1,6 @@
 # ggsurvfit (development version)
 
-* By default, a model plot created with `ggsurvfit()` or `ggcuminc()` uses the color aesthetic to plot curves by the stratifying variable(s), and further, `ggcuminc()` uses the linetype aesthetic for plots that contain multiple outcomes (i.e. competing events). We now introduce the global option `"ggsurvfit.switch-color-linetype"` to switch these defaults, giving users more flexibility over the output figures. (#166)
+* By default, a model plot created with `ggsurvfit()` or `ggcuminc()` uses the color aesthetic to plot curves by the stratifying variable(s), and further, `ggcuminc()` uses the linetype aesthetic for plots that contain multiple outcomes (i.e. competing events). We now introduce the global option `"ggsurvfit.switch-color-linetype"` to switch these defaults, giving users more flexibility over the output figures. Furthermore, when the `linetype_aes=` argument is called in a situation when it does not apply, it will be silently ignored (previsouly, an error message _may_ have been thrown). (#166)
 
 * Slightly increased the padding to the right of the plot when `scale_ggsurvfit()` is called. (#165)
 

R/ggsurvfit.R

@@ -107,19 +107,19 @@ ggsurvfit <- function(x, type = "survival",
 
 # prepare `aes()` call
 .construct_aes <- function(df, linetype_aes, outcome = NULL) {
-  if (!is.null(outcome) &&
-      length(outcome) > 1 &&
-      isTRUE(linetype_aes) &&
-      !isTRUE(getOption("ggsurvfit.switch-color-linetype"))) {
-    cli_abort("Cannot specify multiple outcomes with {.code linetype_aes=TRUE}.")
-  }
-  if ("strata" %in% names(df) &&
-      length(unique(df$strata)) > 1 &&
-      isTRUE(linetype_aes) &&
-      isTRUE(getOption("ggsurvfit.switch-color-linetype"))) {
-    cli_abort("Cannot specify stratum with {.code linetype_aes=TRUE}.")
+  # if `linetype_aes` specified in an inappropriate situation, it is silently ignored
+  if (
+    isTRUE(linetype_aes) &&
+    !(
+      (is.null(outcome) && "strata" %in% names(df) && !isTRUE(getOption("ggsurvfit.switch-color-linetype"))) || # ggsurvfit with strata
+      (!is.null(outcome) && length(outcome) == 1L && "strata" %in% names(df) && !isTRUE(getOption("ggsurvfit.switch-color-linetype"))) || # ggcuminc with 1 outcome and strata
+      (!is.null(outcome) && length(outcome) > 1L && !"strata" %in% names(df) && isTRUE(getOption("ggsurvfit.switch-color-linetype"))) # ggcuminc with 2+ outcomes and no strata
+    )
+  ) {
+    linetype_aes <- FALSE
   }
 
+
   # setting aes() --------------------------------------------------------------
   aes_args <-
     list(
@@ -154,6 +154,8 @@ ggsurvfit <- function(x, type = "survival",
         )
       )
   }
+
+  # adding linetype_aes argument -----------------------------------------------
   if (isTRUE(linetype_aes) &&
       "strata" %in% names(df) &&
       !isTRUE(getOption("ggsurvfit.switch-color-linetype"))) {

README.Rmd

@@ -17,8 +17,8 @@ knitr::opts_chunk$set(
 # ggsurvfit <a href="https://www.danieldsjoberg.com/ggsurvfit/"><img src="man/figures/logo.png" align="right" height="138" /></a>
 
 <!-- badges: start -->
-[![R-CMD-check](https://github.com/pharmaverse/ggsurvfit/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ddsjoberg/ggsurvfit/actions/workflows/R-CMD-check.yaml)
-[![Codecov test coverage](https://codecov.io/gh/pharmaverse/ggsurvfit/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ddsjoberg/ggsurvfit?branch=main)
+[![R-CMD-check](https://github.com/pharmaverse/ggsurvfit/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/pharmaverse/ggsurvfit/actions/workflows/R-CMD-check.yaml)
+[![Codecov test coverage](https://codecov.io/gh/pharmaverse/ggsurvfit/branch/main/graph/badge.svg)](https://app.codecov.io/gh/pharmaverse/ggsurvfit?branch=main)
 [![CRAN status](https://www.r-pkg.org/badges/version/ggsurvfit)](https://CRAN.R-project.org/package=ggsurvfit)
 [![](https://cranlogs.r-pkg.org/badges/ggsurvfit)](https://cran.r-project.org/package=ggsurvfit)
 [<img src="http://pharmaverse.org/shields/ggsurvfit.svg">](https://pharmaverse.org)

README.md

@@ -5,9 +5,9 @@
 
 <!-- badges: start -->
 
-[![R-CMD-check](https://github.com/pharmaverse/ggsurvfit/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ddsjoberg/ggsurvfit/actions/workflows/R-CMD-check.yaml)
+[![R-CMD-check](https://github.com/pharmaverse/ggsurvfit/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/pharmaverse/ggsurvfit/actions/workflows/R-CMD-check.yaml)
 [![Codecov test
-coverage](https://codecov.io/gh/pharmaverse/ggsurvfit/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ddsjoberg/ggsurvfit?branch=main)
+coverage](https://codecov.io/gh/pharmaverse/ggsurvfit/branch/main/graph/badge.svg)](https://app.codecov.io/gh/pharmaverse/ggsurvfit?branch=main)
 [![CRAN
 status](https://www.r-pkg.org/badges/version/ggsurvfit)](https://CRAN.R-project.org/package=ggsurvfit)
 [![](https://cranlogs.r-pkg.org/badges/ggsurvfit)](https://cran.r-project.org/package=ggsurvfit)

tests/testthat/test-ggcuminc.R

@@ -19,10 +19,13 @@ test_that("ggcuminc() works", {
 
   expect_error(ggcuminc(mtcars))
   expect_error(ggcuminc(cuminc1, outcome = "not an outcome"))
+
+  # the linetype_aes argument is silently ignored here
   expect_error(
     ggcuminc(cuminc1,
              outcome = c("death from cancer", "death other causes"),
-             linetype_aes = TRUE)
+             linetype_aes = TRUE),
+    NA
   )
   expect_error(
     ggcuminc(cuminc1, outcome = c("death from cancer", "death other causes")),