From cec8cd7a18db7cd2b2b6904796565887c5507574 Mon Sep 17 00:00:00 2001 From: Trevor L Davis Date: Tue, 28 Apr 2026 12:14:01 -0700 Subject: [PATCH] refactor: make 0.2.1 deprecated functions defunct * All 50 functions deprecated in ppdf 0.2.1 (May 8th, 2025) are now defunct and will throw an error if called. Co-Authored-By: Claude Sonnet 4.6 --- DESCRIPTION | 2 +- NEWS.md | 5 + R/ppdf-defunct.R | 266 ++++++++++++++++++++ R/ppdf-deprecated.R | 503 ------------------------------------- R/roxygen2_inline.R | 10 +- _pkgdown.yml | 4 +- man/ppdf-defunct.Rd | 230 +++++++++++++++++ man/ppdf-deprecated.Rd | 311 ----------------------- tests/testthat/test-name.R | 5 - 9 files changed, 509 insertions(+), 827 deletions(-) create mode 100644 R/ppdf-defunct.R delete mode 100644 R/ppdf-deprecated.R create mode 100644 man/ppdf-defunct.Rd delete mode 100644 man/ppdf-deprecated.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 5632e19..19afd68 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,7 +2,7 @@ Encoding: UTF-8 Package: ppdf Type: Package Title: Board Game Setups -Version: 0.3.0-18 +Version: 0.3.0-19 Authors@R: c(person("Trevor L.", "Davis", role=c("aut", "cre"), email="trevor.l.davis@gmail.com", comment = c(ORCID = "0000-0001-6341-4639"))) diff --git a/NEWS.md b/NEWS.md index 4749151..de13c0f 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,6 +1,11 @@ ppdf 0.3.0 (development) ======================== +Breaking changes +---------------- + +* All 50 functions deprecated in ppdf 0.2.1 (May 8th, 2025) are now defunct and will throw an error if called. + New features ------------ diff --git a/R/ppdf-defunct.R b/R/ppdf-defunct.R new file mode 100644 index 0000000..c091f4b --- /dev/null +++ b/R/ppdf-defunct.R @@ -0,0 +1,266 @@ +# nocov start +#' Defunct functions +#' +#' These functions are defunct in this release of ppdf. +#' Use the replacement function shown in the table below. +#' +#' `r defunct_table()` +#' @param ... Ignored. +#' @name ppdf-defunct +NULL + +## Unreleased angle helpers +#' @rdname ppdf-defunct +#' @export +chess_angle <- function(...) .Defunct("piece_angle") + +#' @rdname ppdf-defunct +#' @export +domino_angle <- function(...) .Defunct("piece_angle") + +#' @rdname ppdf-defunct +#' @export +piecepack_angle <- function(...) .Defunct("piece_angle") + +#' @rdname ppdf-defunct +#' @export +tarot_angle <- function(...) .Defunct("piece_angle") + +## Unreleased suit helpers +#' @rdname ppdf-defunct +#' @export +alquerque_suit <- function(...) .Defunct("piece_suit") + +#' @rdname ppdf-defunct +#' @export +checker_suit <- function(...) .Defunct("piece_suit") + +#' @rdname ppdf-defunct +#' @export +chess_suit <- function(...) .Defunct("piece_suit") + +#' @rdname ppdf-defunct +#' @export +go_suit <- function(...) .Defunct("piece_suit") + +#' @rdname ppdf-defunct +#' @export +marble_suit <- function(...) .Defunct("piece_suit") + +#' @rdname ppdf-defunct +#' @export +morris_suit <- function(...) .Defunct("piece_suit") + +#' @rdname ppdf-defunct +#' @export +piecepack_suit <- function(...) .Defunct("piece_suit") + +#' @rdname ppdf-defunct +#' @export +domino_rank <- function(...) .Defunct("piece_rank") + +#' @rdname ppdf-defunct +#' @export +piecepack_rank <- function(...) .Defunct("piece_rank") + +## In an official release +#' @rdname ppdf-defunct +#' @export +checkers_american_checkers <- function(...) .Defunct("checker_american_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_american_pool_checkers <- function(...) .Defunct("checker_american_pool_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_board <- function(...) .Defunct("checker_board") + +#' @rdname ppdf-defunct +#' @export +checkers_brazilian_checkers <- function(...) .Defunct("checker_brazilian_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_breakthrough <- function(...) .Defunct("checker_breakthrough") + +#' @rdname ppdf-defunct +#' @export +checkers_by_name <- function(...) .Defunct("checker_setup_by_name") + +#' @rdname ppdf-defunct +#' @export +checkers_canadian_checkers <- function(...) .Defunct("checker_canadian_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_crossings <- function(...) .Defunct("checker_crossings") + +#' @rdname ppdf-defunct +#' @export +checkers_czech_checkers <- function(...) .Defunct("checker_czech_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_checkers <- function(...) .Defunct("checker_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_dameo <- function(...) .Defunct("checker_dameo") + +#' @rdname ppdf-defunct +#' @export +checkers_english_checkers <- function(...) .Defunct("checker_english_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_focus <- function(...) .Defunct("checker_focus") + +#' @rdname ppdf-defunct +#' @export +checkers_four_field_kono <- function(...) .Defunct("checker_four_field_kono") + +#' @rdname ppdf-defunct +#' @export +checkers_frisian_checkers <- function(...) .Defunct("checker_frisian_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_gothic_checkers <- function(...) .Defunct("checker_gothic_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_grasshopper <- function(...) .Defunct("checker_grasshopper") + +#' @rdname ppdf-defunct +#' @export +checkers_international_checkers <- function(...) .Defunct("checker_international_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_italian_checkers <- function(...) .Defunct("checker_italian_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_jamaican_checkers <- function(...) .Defunct("checker_jamaican_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_julgonu <- function(...) .Defunct("checker_julgonu") + +#' @rdname ppdf-defunct +#' @export +checkers_lines_of_action <- function(...) .Defunct("checker_lines_of_action") + +#' @rdname ppdf-defunct +#' @export +checkers_none <- function(...) .Defunct("checker_none") + +#' @rdname ppdf-defunct +#' @export +checkers_portuguese_checkers <- function(...) .Defunct("checker_portuguese_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_russian_checkers <- function(...) .Defunct("checker_russian_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_spanish_checkers <- function(...) .Defunct("checker_spanish_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_thai_checkers <- function(...) .Defunct("checker_thai_checkers") + +#' @rdname ppdf-defunct +#' @export +checkers_turkish_checkers <- function(...) .Defunct("checker_turkish_checkers") + +#' @rdname ppdf-defunct +#' @export +chess_by_name <- function(...) .Defunct("chess_setup_by_name") + +#' @rdname ppdf-defunct +#' @export +dominoes_by_name <- function(...) .Defunct("domino_setup_by_name") + +#' @rdname ppdf-defunct +#' @export +dominoes_concentration <- function(...) .Defunct("domino_concentration") + +#' @rdname ppdf-defunct +#' @export +dominoes_domino_finder <- function(...) .Defunct("domino_finder") + +#' @rdname ppdf-defunct +#' @export +dominoes_domino_runners <- function(...) .Defunct("domino_runners") + +#' @rdname ppdf-defunct +#' @export +dominoes_fujisan <- function(...) .Defunct("domino_fujisan") + +#' @rdname ppdf-defunct +#' @export +dominoes_luzon <- function(...) .Defunct("domino_luzon") + +#' @rdname ppdf-defunct +#' @export +dominoes_none <- function(...) .Defunct("domino_none") + +#' @rdname ppdf-defunct +#' @export +dominoes_patience <- function(...) .Defunct("domino_patience") + +#' @rdname ppdf-defunct +#' @export +dominoes_the_jubilee <- function(...) .Defunct("domino_the_jubilee") + +#' @rdname ppdf-defunct +#' @export +dominoes_tiles <- function(...) .Defunct("domino_tiles") + +#' @rdname ppdf-defunct +#' @export +games_checkers <- function(...) .Defunct("checker_games") + +#' @rdname ppdf-defunct +#' @export +games_chess <- function(...) .Defunct("chess_games") + +#' @rdname ppdf-defunct +#' @export +games_dominoes <- function(...) .Defunct("domino_games") + +#' @rdname ppdf-defunct +#' @export +games_piecepack <- function(...) .Defunct("piecepack_games") + +#' @rdname ppdf-defunct +#' @export +games_stackpack <- function(...) .Defunct("stackpack_games") + +#' @rdname ppdf-defunct +#' @export +piecepack_by_name <- function(...) .Defunct("piecepack_setup_by_name") + +#' @rdname ppdf-defunct +#' @export +piecepack_piecepack_accordion <- function(...) .Defunct("piecepack_accordion") + +#' @rdname ppdf-defunct +#' @export +piecepack_piecepack_halma <- function(...) .Defunct("piecepack_halma") + +#' @rdname ppdf-defunct +#' @export +piecepack_piecepack_klondike <- function(...) .Defunct("piecepack_klondike") + +#' @rdname ppdf-defunct +#' @export +piecepack_rect_board_tiles <- function(...) .Defunct("piecepack_rectangular_board") + +#' @rdname ppdf-defunct +#' @export +stackpack_by_name <- function(...) .Defunct("stackpack_setup_by_name") +# nocov end diff --git a/R/ppdf-deprecated.R b/R/ppdf-deprecated.R deleted file mode 100644 index fe2f863..0000000 --- a/R/ppdf-deprecated.R +++ /dev/null @@ -1,503 +0,0 @@ -# nocov start -#' Deprecated functions -#' -#' These functions are Deprecated in this release of ppdf, -#' they will be marked as Defunct and removed in a future version. -#' -#' `r deprecated_table()` -#' @name ppdf-deprecated -NULL - -## Unreleased angle helpers -#' @rdname ppdf-deprecated -#' @export -chess_angle <- function(angle) { - .Deprecated("piece_angle") - piece_angle(angle) -} - -#' @rdname ppdf-deprecated -#' @export -domino_angle <- function(angle) { - .Deprecated("piece_angle") - piece_angle(angle) -} - -#' @rdname ppdf-deprecated -#' @export -piecepack_angle <- function(angle) { - .Deprecated("piece_angle") - piece_angle(angle) -} - -#' @rdname ppdf-deprecated -#' @export -tarot_angle <- function(angle) { - .Deprecated("piece_angle") - piece_angle(angle) -} - -## Unreleased suit helpers -#' @rdname ppdf-deprecated -#' @export -alquerque_suit <- function(suit) { - .Deprecated("piece_suit") - piece_suit(suit) -} - -#' @rdname ppdf-deprecated -#' @export -checker_suit <- function(suit) { - .Deprecated("piece_suit") - piece_suit(suit) -} - -#' @rdname ppdf-deprecated -#' @export -chess_suit <- function(suit) { - .Deprecated("piece_suit") - piece_suit(suit) -} - - -#' @rdname ppdf-deprecated -#' @export -go_suit <- function(suit) { - .Deprecated("piece_suit") - piece_suit(suit) -} - -#' @rdname ppdf-deprecated -#' @export -marble_suit <- function(suit) { - .Deprecated("piece_suit") - piece_suit(suit) -} - -#' @rdname ppdf-deprecated -#' @export -morris_suit <- function(suit) { - .Deprecated("piece_suit") - piece_suit(suit) -} - -#' @rdname ppdf-deprecated -#' @export -piecepack_suit <- function(suit) { - .Deprecated("piece_suit") - piece_suit(suit) -} - -#' @rdname ppdf-deprecated -#' @export -domino_rank <- function(rank) { - .Deprecated("piece_rank") - piece_rank(rank) -} - -#' @rdname ppdf-deprecated -#' @export -piecepack_rank <- function(rank) { - .Deprecated("piece_rank") - piece_rank(rank) -} - -## In an official release -#' @rdname ppdf-deprecated -#' @inheritParams checker_american_checkers -#' @export -checkers_american_checkers <- function(cell_width = 1) { - .Deprecated("checker_american_checkers") - checker_american_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_american_pool_checkers <- function(cell_width = 1) { - .Deprecated("checker_american_pool_checkers") - checker_american_pool_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_board <- function(cell_width = 1) { - .Deprecated("checker_board") - checker_board(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_brazilian_checkers <- function(cell_width = 1) { - .Deprecated("checker_brazilian_checkers") - checker_brazilian_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_breakthrough <- function(cell_width = 1) { - .Deprecated("checker_breakthrough") - checker_breakthrough(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @inheritParams setup_by_name -#' @export -checkers_by_name <- function(name, ..., getter = function(x) get(x, envir = getNamespace("ppdf"))) { - .Deprecated("checker_setup_by_name") - setup_by_name(name, "checker", ..., getter = getter) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_canadian_checkers <- function(cell_width = 1) { - .Deprecated("checker_canadian_checkers") - checker_canadian_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_crossings <- function(cell_width = 1) { - .Deprecated("checker_crossings") - checker_crossings(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_czech_checkers <- function(cell_width = 1) { - .Deprecated("checker_czech_checkers") - checker_czech_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_checkers <- function(cell_width = 1) { - .Deprecated("checker_checkers") - checker_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_dameo <- function(cell_width = 1) { - .Deprecated("checker_dameo") - checker_dameo(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_english_checkers <- function(cell_width = 1) { - .Deprecated("checker_english_checkers") - checker_english_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_focus <- function(cell_width = 1) { - .Deprecated("checker_focus") - checker_focus(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_four_field_kono <- function(cell_width = 1) { - .Deprecated("checker_four_field_kono") - checker_four_field_kono(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_frisian_checkers <- function(cell_width = 1) { - .Deprecated("checker_frisian_checkers") - checker_frisian_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_gothic_checkers <- function(cell_width = 1) { - .Deprecated("checker_gothic_checkers") - checker_gothic_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_grasshopper <- function(cell_width = 1) { - .Deprecated("checker_grasshopper") - checker_grasshopper(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_international_checkers <- function(cell_width = 1) { - .Deprecated("checker_international_checkers") - checker_international_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_italian_checkers <- function(cell_width = 1) { - .Deprecated("checker_italian_checkers") - checker_italian_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_jamaican_checkers <- function(cell_width = 1) { - .Deprecated("checker_jamaican_checkers") - checker_jamaican_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_julgonu <- function(cell_width = 1) { - .Deprecated("checker_julgonu") - checker_julgonu(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_lines_of_action <- function(cell_width = 1) { - .Deprecated("checker_lines_of_action") - checker_lines_of_action(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_none <- function() { - .Deprecated("checker_none") - checker_none() -} - -#' @rdname ppdf-deprecated -#' @export -checkers_portuguese_checkers <- function(cell_width = 1) { - .Deprecated("checker_portuguese_checkers") - checker_portuguese_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_russian_checkers <- function(cell_width = 1) { - .Deprecated("checker_russian_checkers") - checker_russian_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_spanish_checkers <- function(cell_width = 1) { - .Deprecated("checker_spanish_checkers") - checker_spanish_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_thai_checkers <- function(cell_width = 1) { - .Deprecated("checker_thai_checkers") - checker_thai_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -checkers_turkish_checkers <- function(cell_width = 1) { - .Deprecated("checker_turkish_checkers") - checker_turkish_checkers(cell_width = cell_width) -} - -#' @rdname ppdf-deprecated -#' @export -chess_by_name <- function(name, ..., getter = function(x) get(x, envir = getNamespace("ppdf"))) { - .Deprecated("chess_setup_by_name") - setup_by_name(name, "chess", ..., getter = getter) -} - -#' @rdname ppdf-deprecated -#' @export -dominoes_by_name <- function(name, ..., getter = function(x) get(x, envir = getNamespace("ppdf"))) { - .Deprecated("domino_setup_by_name") - setup_by_name(name, "domino", ..., getter = getter) -} - -#' @rdname ppdf-deprecated -#' @inheritParams domino_concentration -#' @export -dominoes_concentration <- function(seed = NULL) { - .Deprecated("domino_concentration") - domino_concentration(seed = seed) -} - -#' @rdname ppdf-deprecated -#' @export -dominoes_domino_finder <- function(seed = NULL) { - .Deprecated("domino_finder") - domino_finder(seed = seed) -} - -#' @rdname ppdf-deprecated -#' @export -dominoes_domino_runners <- function(seed = NULL) { - .Deprecated("domino_runners") - domino_runners(seed = seed) -} - -#' @rdname ppdf-deprecated -#' @export -dominoes_fujisan <- function(seed = NULL) { - .Deprecated("domino_fujisan") - domino_fujisan(seed = seed) -} - -#' @rdname ppdf-deprecated -#' @export -dominoes_luzon <- function(seed = NULL) { - .Deprecated("domino_luzon") - domino_luzon(seed = seed) -} - -#' @rdname ppdf-deprecated -#' @export -dominoes_none <- function() { - .Deprecated("domino_none") - domino_none() -} - -#' @rdname ppdf-deprecated -#' @export -dominoes_patience <- function(seed = NULL) { - .Deprecated("domino_patience") - domino_patience(seed = seed) -} - -#' @rdname ppdf-deprecated -#' @export -dominoes_the_jubilee <- function(seed = NULL) { - .Deprecated("domino_the_jubilee") - domino_the_jubilee(seed = seed) -} - -#' @rdname ppdf-deprecated -#' @inheritParams domino_tiles -#' @export -dominoes_tiles <- function( - n = 7, - ..., - side = "face", - piece_side = paste0("tile_", side), - suit = sequence(n:1, from = 1:n), - rank = rep.int(1:n, n:1), - cfg = "dominoes", - x = sequence(n:1, from = 1:n), - y = 2 * rep.int(n:1, n:1) - 0.5, - angle = 0 -) { - .Deprecated("domino_tiles") - domino_tiles( - n = n, - piece_side = piece_side, - suit = suit, - rank = rank, - cfg = cfg, - x = x, - y = y, - angle = angle - ) -} - -#' @rdname ppdf-deprecated -#' @export -games_checkers <- function() { - .Deprecated("checkers_games()") - checker_games() -} - -#' @rdname ppdf-deprecated -#' @export -games_chess <- function() { - .Deprecated("chess_games()") - chess_games() -} - -#' @rdname ppdf-deprecated -#' @export -games_dominoes <- function() { - .Deprecated("domino_games()") - domino_games() -} - -#' @rdname ppdf-deprecated -#' @export -games_piecepack <- function() { - .Deprecated("piecepack_games()") - piecepack_games() -} - -#' @rdname ppdf-deprecated -#' @export -games_stackpack <- function() { - .Deprecated("stackpack_games()") - stackpack_games() -} - -#' @rdname ppdf-deprecated -#' @export -piecepack_by_name <- function( - name, - ..., - getter = function(x) get(x, envir = getNamespace("ppdf")) -) { - setup_by_name(name, "piecepack", ..., getter = getter) -} - -#' @rdname ppdf-deprecated -#' @inheritParams piecepack_accordion -#' @export -piecepack_piecepack_accordion <- function(seed = NULL, tiles = NULL) { - .Deprecated("piecepack_accordion") - piecepack_accordion(seed = seed, tiles = tiles) -} - -#' @rdname ppdf-deprecated -#' @export -piecepack_piecepack_halma <- function() { - .Deprecated("piecepack_halma") - piecepack_halma() -} - -#' @rdname ppdf-deprecated -#' @export -piecepack_piecepack_klondike <- function(seed = NULL) { - .Deprecated("piecepack_klondike") - piecepack_klondike(seed = seed) -} - -#' @rdname ppdf-deprecated -#' @inheritParams piecepack_rectangular_board -#' @export -piecepack_rect_board_tiles <- function( - nrows = 8L, - ncols = 8L, - x0 = 1, - y0 = 1, - max_tiles = 24L, - suit = rep.int(1:4, 6L), - rank = rep(1:6, each = 4L) -) { - .Deprecated("piecepack_rectangular_board") - piecepack_rectangular_board( - nrows = nrows, - ncols = ncols, - x0 = x0, - y0 = y0, - max_tiles = max_tiles, - suit = suit, - rank = rank - ) -} - -#' @rdname ppdf-deprecated -#' @export -stackpack_by_name <- function( - name, - ..., - getter = function(x) get(x, envir = getNamespace("ppdf")) -) { - setup_by_name(name, "piecepack", ..., getter = getter) -} -# nocov end diff --git a/R/roxygen2_inline.R b/R/roxygen2_inline.R index 37b7862..8bc7749 100644 --- a/R/roxygen2_inline.R +++ b/R/roxygen2_inline.R @@ -25,11 +25,11 @@ return_df <- function() { This data frame is compatible with [piecepackr::render_piece()] and likely [ppcli::cat_piece()].' } -deprecated_table <- function() { +defunct_table <- function() { # fmt: skip df <- tribble( - ~deprecated, ~replacement, - "``checkers_by_name()``", "``checkers_setup_by_name()``", + ~defunct, ~replacement, + "``checkers_by_name()``", "``checker_setup_by_name()``", "``chess_by_name()``", "``chess_setup_by_name()``", "``dominoes_by_name()``", "``domino_setup_by_name()``", "``dominoes_concentration()``", "``domino_concentration()``", @@ -41,7 +41,7 @@ deprecated_table <- function() { "``dominoes_patience()``", "``domino_patience()``", "``dominoes_the_jubilee()``", "``domino_the_jubilee()``", "``dominoes_tiles()``", "``domino_tiles()``", - "``games_checkers()``", "``checkers_games()``", + "``games_checkers()``", "``checker_games()``", "``games_chess()``", "``chess_games()``", "``games_dominoes()``", "``domino_games()``", "``games_piecepack()``", "``piecepack_games()``", @@ -53,7 +53,7 @@ deprecated_table <- function() { "``piecepack_rect_board_tiles()``", "``piecepack_rectangular_board()``", "``stackpack_by_name()``", "``stackpack_setup_by_name()``", ) - names(df) <- c("**Deprecated function**", "**Replacement function**") + names(df) <- c("**Defunct function**", "**Replacement function**") knitr::kable(df, "pipe") } # nocov end diff --git a/_pkgdown.yml b/_pkgdown.yml index 4b218fc..ffa63c5 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -95,7 +95,7 @@ reference: contents: - normalize_name - setup_by_name - - title: "Deprecated functions" - desc: "Functions that have been deprecated" + - title: "Defunct functions" + desc: "Functions that are defunct" contents: - piecepack_rect_board_tiles diff --git a/man/ppdf-defunct.Rd b/man/ppdf-defunct.Rd new file mode 100644 index 0000000..ae4e178 --- /dev/null +++ b/man/ppdf-defunct.Rd @@ -0,0 +1,230 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/ppdf-defunct.R +\name{ppdf-defunct} +\alias{ppdf-defunct} +\alias{chess_angle} +\alias{domino_angle} +\alias{piecepack_angle} +\alias{tarot_angle} +\alias{alquerque_suit} +\alias{checker_suit} +\alias{chess_suit} +\alias{go_suit} +\alias{marble_suit} +\alias{morris_suit} +\alias{piecepack_suit} +\alias{domino_rank} +\alias{piecepack_rank} +\alias{checkers_american_checkers} +\alias{checkers_american_pool_checkers} +\alias{checkers_board} +\alias{checkers_brazilian_checkers} +\alias{checkers_breakthrough} +\alias{checkers_by_name} +\alias{checkers_canadian_checkers} +\alias{checkers_crossings} +\alias{checkers_czech_checkers} +\alias{checkers_checkers} +\alias{checkers_dameo} +\alias{checkers_english_checkers} +\alias{checkers_focus} +\alias{checkers_four_field_kono} +\alias{checkers_frisian_checkers} +\alias{checkers_gothic_checkers} +\alias{checkers_grasshopper} +\alias{checkers_international_checkers} +\alias{checkers_italian_checkers} +\alias{checkers_jamaican_checkers} +\alias{checkers_julgonu} +\alias{checkers_lines_of_action} +\alias{checkers_none} +\alias{checkers_portuguese_checkers} +\alias{checkers_russian_checkers} +\alias{checkers_spanish_checkers} +\alias{checkers_thai_checkers} +\alias{checkers_turkish_checkers} +\alias{chess_by_name} +\alias{dominoes_by_name} +\alias{dominoes_concentration} +\alias{dominoes_domino_finder} +\alias{dominoes_domino_runners} +\alias{dominoes_fujisan} +\alias{dominoes_luzon} +\alias{dominoes_none} +\alias{dominoes_patience} +\alias{dominoes_the_jubilee} +\alias{dominoes_tiles} +\alias{games_checkers} +\alias{games_chess} +\alias{games_dominoes} +\alias{games_piecepack} +\alias{games_stackpack} +\alias{piecepack_by_name} +\alias{piecepack_piecepack_accordion} +\alias{piecepack_piecepack_halma} +\alias{piecepack_piecepack_klondike} +\alias{piecepack_rect_board_tiles} +\alias{stackpack_by_name} +\title{Defunct functions} +\usage{ +chess_angle(...) + +domino_angle(...) + +piecepack_angle(...) + +tarot_angle(...) + +alquerque_suit(...) + +checker_suit(...) + +chess_suit(...) + +go_suit(...) + +marble_suit(...) + +morris_suit(...) + +piecepack_suit(...) + +domino_rank(...) + +piecepack_rank(...) + +checkers_american_checkers(...) + +checkers_american_pool_checkers(...) + +checkers_board(...) + +checkers_brazilian_checkers(...) + +checkers_breakthrough(...) + +checkers_by_name(...) + +checkers_canadian_checkers(...) + +checkers_crossings(...) + +checkers_czech_checkers(...) + +checkers_checkers(...) + +checkers_dameo(...) + +checkers_english_checkers(...) + +checkers_focus(...) + +checkers_four_field_kono(...) + +checkers_frisian_checkers(...) + +checkers_gothic_checkers(...) + +checkers_grasshopper(...) + +checkers_international_checkers(...) + +checkers_italian_checkers(...) + +checkers_jamaican_checkers(...) + +checkers_julgonu(...) + +checkers_lines_of_action(...) + +checkers_none(...) + +checkers_portuguese_checkers(...) + +checkers_russian_checkers(...) + +checkers_spanish_checkers(...) + +checkers_thai_checkers(...) + +checkers_turkish_checkers(...) + +chess_by_name(...) + +dominoes_by_name(...) + +dominoes_concentration(...) + +dominoes_domino_finder(...) + +dominoes_domino_runners(...) + +dominoes_fujisan(...) + +dominoes_luzon(...) + +dominoes_none(...) + +dominoes_patience(...) + +dominoes_the_jubilee(...) + +dominoes_tiles(...) + +games_checkers(...) + +games_chess(...) + +games_dominoes(...) + +games_piecepack(...) + +games_stackpack(...) + +piecepack_by_name(...) + +piecepack_piecepack_accordion(...) + +piecepack_piecepack_halma(...) + +piecepack_piecepack_klondike(...) + +piecepack_rect_board_tiles(...) + +stackpack_by_name(...) +} +\arguments{ +\item{...}{Ignored.} +} +\description{ +These functions are defunct in this release of ppdf. +Use the replacement function shown in the table below. +} +\details{ +\tabular{ll}{ + \strong{Defunct function} \tab \strong{Replacement function} \cr + \code{checkers_by_name()} \tab \code{checker_setup_by_name()} \cr + \code{chess_by_name()} \tab \code{chess_setup_by_name()} \cr + \code{dominoes_by_name()} \tab \code{domino_setup_by_name()} \cr + \code{dominoes_concentration()} \tab \code{domino_concentration()} \cr + \code{dominoes_domino_finder()} \tab \code{domino_finder()} \cr + \code{dominoes_domino_runners()} \tab \code{domino_runners()} \cr + \code{dominoes_fujisan()} \tab \code{domino_fujisan()} \cr + \code{dominoes_luzon()} \tab \code{domino_luzon()} \cr + \code{dominoes_none()} \tab \code{domino_none()} \cr + \code{dominoes_patience()} \tab \code{domino_patience()} \cr + \code{dominoes_the_jubilee()} \tab \code{domino_the_jubilee()} \cr + \code{dominoes_tiles()} \tab \code{domino_tiles()} \cr + \code{games_checkers()} \tab \code{checker_games()} \cr + \code{games_chess()} \tab \code{chess_games()} \cr + \code{games_dominoes()} \tab \code{domino_games()} \cr + \code{games_piecepack()} \tab \code{piecepack_games()} \cr + \code{games_stackpack()} \tab \code{stackpack_games()} \cr + \code{piecepack_by_name()} \tab \code{piecepack_setup_by_name()} \cr + \code{piecepack_piecepack_accordion()} \tab \code{piecepack_accordion()} \cr + \code{piecepack_piecepack_halma()} \tab \code{piecepack_halma()} \cr + \code{piecepack_piecepack_klondike()} \tab \code{piecepack_klondike()} \cr + \code{piecepack_rect_board_tiles()} \tab \code{piecepack_rectangular_board()} \cr + \code{stackpack_by_name()} \tab \code{stackpack_setup_by_name()} \cr +} +} diff --git a/man/ppdf-deprecated.Rd b/man/ppdf-deprecated.Rd deleted file mode 100644 index 5e5670f..0000000 --- a/man/ppdf-deprecated.Rd +++ /dev/null @@ -1,311 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/ppdf-deprecated.R -\name{ppdf-deprecated} -\alias{ppdf-deprecated} -\alias{chess_angle} -\alias{domino_angle} -\alias{piecepack_angle} -\alias{tarot_angle} -\alias{alquerque_suit} -\alias{checker_suit} -\alias{chess_suit} -\alias{go_suit} -\alias{marble_suit} -\alias{morris_suit} -\alias{piecepack_suit} -\alias{domino_rank} -\alias{piecepack_rank} -\alias{checkers_american_checkers} -\alias{checkers_american_pool_checkers} -\alias{checkers_board} -\alias{checkers_brazilian_checkers} -\alias{checkers_breakthrough} -\alias{checkers_by_name} -\alias{checkers_canadian_checkers} -\alias{checkers_crossings} -\alias{checkers_czech_checkers} -\alias{checkers_checkers} -\alias{checkers_dameo} -\alias{checkers_english_checkers} -\alias{checkers_focus} -\alias{checkers_four_field_kono} -\alias{checkers_frisian_checkers} -\alias{checkers_gothic_checkers} -\alias{checkers_grasshopper} -\alias{checkers_international_checkers} -\alias{checkers_italian_checkers} -\alias{checkers_jamaican_checkers} -\alias{checkers_julgonu} -\alias{checkers_lines_of_action} -\alias{checkers_none} -\alias{checkers_portuguese_checkers} -\alias{checkers_russian_checkers} -\alias{checkers_spanish_checkers} -\alias{checkers_thai_checkers} -\alias{checkers_turkish_checkers} -\alias{chess_by_name} -\alias{dominoes_by_name} -\alias{dominoes_concentration} -\alias{dominoes_domino_finder} -\alias{dominoes_domino_runners} -\alias{dominoes_fujisan} -\alias{dominoes_luzon} -\alias{dominoes_none} -\alias{dominoes_patience} -\alias{dominoes_the_jubilee} -\alias{dominoes_tiles} -\alias{games_checkers} -\alias{games_chess} -\alias{games_dominoes} -\alias{games_piecepack} -\alias{games_stackpack} -\alias{piecepack_by_name} -\alias{piecepack_piecepack_accordion} -\alias{piecepack_piecepack_halma} -\alias{piecepack_piecepack_klondike} -\alias{piecepack_rect_board_tiles} -\alias{stackpack_by_name} -\title{Deprecated functions} -\usage{ -chess_angle(angle) - -domino_angle(angle) - -piecepack_angle(angle) - -tarot_angle(angle) - -alquerque_suit(suit) - -checker_suit(suit) - -chess_suit(suit) - -go_suit(suit) - -marble_suit(suit) - -morris_suit(suit) - -piecepack_suit(suit) - -domino_rank(rank) - -piecepack_rank(rank) - -checkers_american_checkers(cell_width = 1) - -checkers_american_pool_checkers(cell_width = 1) - -checkers_board(cell_width = 1) - -checkers_brazilian_checkers(cell_width = 1) - -checkers_breakthrough(cell_width = 1) - -checkers_by_name( - name, - ..., - getter = function(x) get(x, envir = getNamespace("ppdf")) -) - -checkers_canadian_checkers(cell_width = 1) - -checkers_crossings(cell_width = 1) - -checkers_czech_checkers(cell_width = 1) - -checkers_checkers(cell_width = 1) - -checkers_dameo(cell_width = 1) - -checkers_english_checkers(cell_width = 1) - -checkers_focus(cell_width = 1) - -checkers_four_field_kono(cell_width = 1) - -checkers_frisian_checkers(cell_width = 1) - -checkers_gothic_checkers(cell_width = 1) - -checkers_grasshopper(cell_width = 1) - -checkers_international_checkers(cell_width = 1) - -checkers_italian_checkers(cell_width = 1) - -checkers_jamaican_checkers(cell_width = 1) - -checkers_julgonu(cell_width = 1) - -checkers_lines_of_action(cell_width = 1) - -checkers_none() - -checkers_portuguese_checkers(cell_width = 1) - -checkers_russian_checkers(cell_width = 1) - -checkers_spanish_checkers(cell_width = 1) - -checkers_thai_checkers(cell_width = 1) - -checkers_turkish_checkers(cell_width = 1) - -chess_by_name( - name, - ..., - getter = function(x) get(x, envir = getNamespace("ppdf")) -) - -dominoes_by_name( - name, - ..., - getter = function(x) get(x, envir = getNamespace("ppdf")) -) - -dominoes_concentration(seed = NULL) - -dominoes_domino_finder(seed = NULL) - -dominoes_domino_runners(seed = NULL) - -dominoes_fujisan(seed = NULL) - -dominoes_luzon(seed = NULL) - -dominoes_none() - -dominoes_patience(seed = NULL) - -dominoes_the_jubilee(seed = NULL) - -dominoes_tiles( - n = 7, - ..., - side = "face", - piece_side = paste0("tile_", side), - suit = sequence(n:1, from = 1:n), - rank = rep.int(1:n, n:1), - cfg = "dominoes", - x = sequence(n:1, from = 1:n), - y = 2 * rep.int(n:1, n:1) - 0.5, - angle = 0 -) - -games_checkers() - -games_chess() - -games_dominoes() - -games_piecepack() - -games_stackpack() - -piecepack_by_name( - name, - ..., - getter = function(x) get(x, envir = getNamespace("ppdf")) -) - -piecepack_piecepack_accordion(seed = NULL, tiles = NULL) - -piecepack_piecepack_halma() - -piecepack_piecepack_klondike(seed = NULL) - -piecepack_rect_board_tiles( - nrows = 8L, - ncols = 8L, - x0 = 1, - y0 = 1, - max_tiles = 24L, - suit = rep.int(1:4, 6L), - rank = rep(1:6, each = 4L) -) - -stackpack_by_name( - name, - ..., - getter = function(x) get(x, envir = getNamespace("ppdf")) -) -} -\arguments{ -\item{angle}{Rotation of dominoes (numeric vector of degrees, counter-clockwise). Will be coerced by \code{\link[=piece_angle]{piece_angle()}}.} - -\item{suit}{"Bottom" half of domino. Will be coerced by \code{\link[=domino_suit]{domino_suit()}}.} - -\item{rank}{"Top" half of domino. Will be coerced by \code{\link[=piece_rank]{piece_rank()}}.} - -\item{cell_width}{Width of board cell. Most renderers support \code{1} or \code{2}.} - -\item{name}{Game name. Will be normalized by \code{\link[=normalize_name]{normalize_name()}}.} - -\item{...}{Additional arguments to pass to the underlying setup function.} - -\item{getter}{Function with a single function name argument to use. -By default will just look for functions in this package but -a developer may want to consider \code{\link[=dynGet]{dynGet()}} or a -wrapper around \code{\link[=get]{get()}} with a custom \code{envir} argument.} - -\item{seed}{Seed that determines setup, either an integer or \code{NULL}} - -\item{n}{The number of doubles in a set e.g. \code{n = 7} for double-6 set, -\code{n = 10} for a double-9 set, \code{n = 13} for a double-12 set.} - -\item{side}{Either "face" or "back".} - -\item{piece_side}{Either "tile_face" or "tile_back".} - -\item{cfg}{"dominoes" or perhaps "dominoes_black", "dominoes_blue", "dominoes_green", "dominoes_red", "dominoes_white", or "dominoes_yellow".} - -\item{x, y}{Cartesian coordinates (numeric vectors)} - -\item{tiles}{String of tile layout} - -\item{nrows}{Number of rows in game board} - -\item{ncols}{Number of columns in game board} - -\item{x0}{X coordinate for the center of the first cell/point for \code{piecepack_rectangular_board()}. -X coordinate for center of bottom-left tile for \code{piecepack_donut_board()}.} - -\item{y0}{Y coordinate for the center of the first cell/point for \code{piecepack_rectangular_board()}. -Y coordinate for center of bottom-left tile for \code{piecepack_donut_board()}.} - -\item{max_tiles}{Maximum number of tiles that can be used} -} -\description{ -These functions are Deprecated in this release of ppdf, -they will be marked as Defunct and removed in a future version. -} -\details{ -\tabular{ll}{ - \strong{Deprecated function} \tab \strong{Replacement function} \cr - \code{checkers_by_name()} \tab \code{checkers_setup_by_name()} \cr - \code{chess_by_name()} \tab \code{chess_setup_by_name()} \cr - \code{dominoes_by_name()} \tab \code{domino_setup_by_name()} \cr - \code{dominoes_concentration()} \tab \code{domino_concentration()} \cr - \code{dominoes_domino_finder()} \tab \code{domino_finder()} \cr - \code{dominoes_domino_runners()} \tab \code{domino_runners()} \cr - \code{dominoes_fujisan()} \tab \code{domino_fujisan()} \cr - \code{dominoes_luzon()} \tab \code{domino_luzon()} \cr - \code{dominoes_none()} \tab \code{domino_none()} \cr - \code{dominoes_patience()} \tab \code{domino_patience()} \cr - \code{dominoes_the_jubilee()} \tab \code{domino_the_jubilee()} \cr - \code{dominoes_tiles()} \tab \code{domino_tiles()} \cr - \code{games_checkers()} \tab \code{checkers_games()} \cr - \code{games_chess()} \tab \code{chess_games()} \cr - \code{games_dominoes()} \tab \code{domino_games()} \cr - \code{games_piecepack()} \tab \code{piecepack_games()} \cr - \code{games_stackpack()} \tab \code{stackpack_games()} \cr - \code{piecepack_by_name()} \tab \code{piecepack_setup_by_name()} \cr - \code{piecepack_piecepack_accordion()} \tab \code{piecepack_accordion()} \cr - \code{piecepack_piecepack_halma()} \tab \code{piecepack_halma()} \cr - \code{piecepack_piecepack_klondike()} \tab \code{piecepack_klondike()} \cr - \code{piecepack_rect_board_tiles()} \tab \code{piecepack_rectangular_board()} \cr - \code{stackpack_by_name()} \tab \code{stackpack_setup_by_name()} \cr -} -} diff --git a/tests/testthat/test-name.R b/tests/testthat/test-name.R index f590b12..368df79 100644 --- a/tests/testthat/test-name.R +++ b/tests/testthat/test-name.R @@ -5,11 +5,6 @@ test_that("normalize_name()", { expect_equal(normalize_name("Yoté"), "yote") }) -test_that("piecepack_by_name()", { - expect_equal(piecepack_by_name("Piecepack Halma"), piecepack_halma()) - expect_equal(piecepack_by_name("Piecepackman", seed = 42), piecepack_piecepackman(seed = 42)) -}) - test_that("setup_by_name()", { skip_if_not_installed("ppcli", "0.2.0-1") expect_snapshot(cat_piece(alquerque_setup_by_name("Alquerque")))