diff --git a/.Rbuildignore b/.Rbuildignore index 05c8ef2..3f916ee 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -10,3 +10,4 @@ cache_test_data ^\.github$ ^\.lintr$ ^data-raw$ +^CRAN-SUBMISSION$ diff --git a/DESCRIPTION b/DESCRIPTION index 28271ac..a1e2efa 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Package: supernova Type: Package Title: Judd, McClelland, & Ryan Formatting for ANOVA Output -Version: 2.5.1 -Date: 2022-01-26 +Version: 2.5.2 +Date: 2022-01-31 Authors@R: c( person( "Adam", "Blake", diff --git a/NEWS.md b/NEWS.md index 6d6c3fc..f76ad7c 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,8 +1,16 @@ +# supernova 2.5.2 + +## Breaking (kind of) + +* Deprecate `superanova()` as it was just an alias to `supernova()` (which was confusing for some students) + + # supernova 2.5.1 * Fix issue where models with long calls (i.e. `deparse(model$call)` results in a vector of length greater than 1) would break the functionality of `listwise_delete()` * Change print method for `generate_models()` to look clean and comprehensible in Jupyter Notebooks. + # supernova 2.5.0 * Change the order of the pairs when plotting `pairwise()` so that the plot matches the table. diff --git a/R/supernova.R b/R/supernova.R index f1aed7e..ec23f37 100644 --- a/R/supernova.R +++ b/R/supernova.R @@ -38,6 +38,13 @@ supernova <- function(fit, type = 3, verbose = TRUE) { } +#' @export +#' @rdname supernova +superanova <- function(fit, type = 3, verbose = TRUE) { + lifecycle::deprecate_stop("2.5.2", "superanova()", "supernova()") +} + + #' @export #' @rdname supernova supernova.lm <- function(fit, type = 3, verbose = TRUE) { @@ -365,11 +372,6 @@ supernova.lmerMod <- function(fit, type = 3, verbose = FALSE) { } -#' @export -#' @rdname supernova -superanova <- supernova - - # Printing ------------------------------------------------------------------------------------ #' @export diff --git a/cran-comments.md b/cran-comments.md index 9501866..8a428c3 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,8 +1,6 @@ ## Release summary -* Fix issue where models with long calls (i.e. `deparse(model$call)` results in a vector of length greater than 1) would break the functionality of `listwise_delete()` -* Change print method for `generate_models()` to look clean and comprehensible in Jupyter Notebooks. - +* Deprecate unused function alias (it was confusing some users and does nothing different) ## Test environments diff --git a/man/supernova.Rd b/man/supernova.Rd index 0709ade..6cb88f7 100644 --- a/man/supernova.Rd +++ b/man/supernova.Rd @@ -2,18 +2,18 @@ % Please edit documentation in R/supernova.R \name{supernova} \alias{supernova} +\alias{superanova} \alias{supernova.lm} \alias{supernova.lmerMod} -\alias{superanova} \title{supernova} \usage{ supernova(fit, type = 3, verbose = TRUE) +superanova(fit, type = 3, verbose = TRUE) + \method{supernova}{lm}(fit, type = 3, verbose = TRUE) \method{supernova}{lmerMod}(fit, type = 3, verbose = FALSE) - -superanova(fit, type = 3, verbose = TRUE) } \arguments{ \item{fit}{A model fit by \code{\link[=lm]{lm()}} or \code{\link[lme4:lmer]{lme4::lmer()}}} diff --git a/tests/testthat/test-supernova.r b/tests/testthat/test-supernova.r index eb3ce21..cd177ac 100644 --- a/tests/testthat/test-supernova.r +++ b/tests/testthat/test-supernova.r @@ -165,10 +165,6 @@ expect_table_data <- function(object, expected, model = "???", type = "???", ... # Structure tests --------------------------------------------------------- -test_that("superanova is an alias of supernova", { - expect_identical(superanova, supernova) -}) - test_that("supernova object has table, fit, and models", { fit <- lm(mpg ~ NULL, mtcars) obj <- supernova(fit, type = 3)