From 3778b827614029038ba5479fab6aca53ac14e2e4 Mon Sep 17 00:00:00 2001 From: Trevor L Davis Date: Thu, 19 Oct 2023 11:23:05 -0700 Subject: [PATCH] chore: Package superseded by {ppdf}. Abandon development. --- DESCRIPTION | 4 +-- NEWS.md | 5 ++++ R/hooks.R | 5 ++++ README.Rrst | 55 +++------------------------------- README.rst | 85 +++-------------------------------------------------- 5 files changed, 20 insertions(+), 134 deletions(-) create mode 100644 R/hooks.R diff --git a/DESCRIPTION b/DESCRIPTION index ac38c83..6dd0395 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,7 +2,7 @@ Encoding: UTF-8 Package: tradgames Type: Package Title: Board Games played with Traditional Game Systems -Version: 0.2.2-3 +Version: 0.3.0-0 Authors@R: c(person("Trevor L", "Davis", role=c("aut", "cre"), email="trevor.l.davis@gmail.com", comment = c(ORCID = "0000-0001-6341-4639"))) @@ -22,4 +22,4 @@ Suggests: vdiffr Remotes: piecepackr/ppgames -RoxygenNote: 7.1.1 +RoxygenNote: 7.2.3 diff --git a/NEWS.md b/NEWS.md index f92af5e..48dc581 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,8 @@ +tradgames 0.3.0 +=============== + +* `{tradgames}` is now superseded by `{ppdf}`: https://github.com/piecepackr/ppdf + tradgames 0.2.1 =============== diff --git a/R/hooks.R b/R/hooks.R new file mode 100644 index 0000000..1458722 --- /dev/null +++ b/R/hooks.R @@ -0,0 +1,5 @@ +.onAttach <- function(libname, pkgname) { + packageStartupMessage(paste("{tradgames} is superseded by {ppdf}", + '`remotes::install_github("piecepackr/ppdf")`', + sep = "\n")) +} diff --git a/README.Rrst b/README.Rrst index fea9bfc..83eea02 100644 --- a/README.Rrst +++ b/README.Rrst @@ -9,55 +9,8 @@ tradgames: Board game graphics for traditional game systems :target: https://app.codecov.io/github/piecepackr/tradgames?branch=master :alt: Coverage Status -.. image:: http://www.repostatus.org/badges/latest/wip.svg - :alt: Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. - :target: http://www.repostatus.org/#wip +.. image:: https://www.repostatus.org/badges/latest/abandoned.svg + :alt: Project Status: Abandoned – Initial development has started, but there has not yet been a stable, usable release; the project has been abandoned and the author(s) do not intend on continuing development. + :target: https://www.repostatus.org/#abandoned - -.. _piecepack: http://www.ludism.org/ppwiki/HomePage -.. _piecepackr: https://github.com/piecepackr/piecepackr -.. _R: https://www.r-project.org/ - -``tradgames`` is an R_ package with functions that help generate board game graphics for games played with traditional board game components. Right now it has a few functions that return the setups for some games that can be drawn with piecepackr_'s ``pmap_piece`` function. - -.. contents:: - -.. {r setup, echo = FALSE} -knitr::opts_chunk$set(fig.path = "man/figures/README-") -.. .. - -Installation ------------- - -To install the ``tradgames`` R package use the following commands in R_: - -.. code:: r - - install.packages("remotes") - remotes::install_github("piecepackr/piecepackr") # recommended - remotes::install_github("piecepackr/ppgames") # recommended - remotes::install_github("piecepackr/tradgames") - -License -------- - -Unless otherwise specified everything in this repo is licensed under the `CC BY-SA 4.0 license `_. - -Starting Boards ---------------- - -This package comes with a few functions that return tibbles representing the starting board arrangement for games played with traditional board game components. These can be visualized with ``piecepackr::pmap_piece`` or ``ppgames::cat_piece``. - -.. {r breakthrough, fig.width=9, fig.height=9, fig.cap='Starting position for Dan Troyka\'s abstract game "Breakthrough"'} -library("tradgames") -library("piecepackr") -pmap_piece(df_breakthrough(), envir=game_systems(), default.units="in", trans=op_transform, op_scale=0.5) -.. .. - -.. {r turkish_draughts, fig.width=9, fig.height=9, fig.cap='Starting position for Turkish Draughts'} -pmap_piece(df_turkish_draughts(), envir=game_systems(), default.units="in", trans=op_transform, op_scale=0.5) -.. .. - -.. {r four_field_kono} -ppgames::cat_piece(df_four_field_kono()) -.. .. +``{tradgames}`` has been superseded by `{ppdf} `_. diff --git a/README.rst b/README.rst index 30dfde8..2dd8548 100644 --- a/README.rst +++ b/README.rst @@ -9,85 +9,8 @@ tradgames: Board game graphics for traditional game systems :target: https://app.codecov.io/github/piecepackr/tradgames?branch=master :alt: Coverage Status -.. image:: http://www.repostatus.org/badges/latest/wip.svg - :alt: Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. - :target: http://www.repostatus.org/#wip - - -.. _piecepack: http://www.ludism.org/ppwiki/HomePage -.. _piecepackr: https://github.com/piecepackr/piecepackr -.. _R: https://www.r-project.org/ - -``tradgames`` is an R_ package with functions that help generate board game graphics for games played with traditional board game components. Right now it has a few functions that return the setups for some games that can be drawn with piecepackr_'s ``pmap_piece`` function. - -.. contents:: - - - -Installation ------------- - -To install the ``tradgames`` R package use the following commands in R_: - -.. code:: r - - install.packages("remotes") - remotes::install_github("piecepackr/piecepackr") # recommended - remotes::install_github("piecepackr/ppgames") # recommended - remotes::install_github("piecepackr/tradgames") - -License -------- - -Unless otherwise specified everything in this repo is licensed under the `CC BY-SA 4.0 license `_. - -Starting Boards ---------------- - -This package comes with a few functions that return tibbles representing the starting board arrangement for games played with traditional board game components. These can be visualized with ``piecepackr::pmap_piece`` or ``ppgames::cat_piece``. - - -.. sourcecode:: r - - - library("tradgames") - library("piecepackr") - pmap_piece(df_breakthrough(), envir=game_systems(), default.units="in", trans=op_transform, op_scale=0.5) - -.. figure:: man/figures/README-breakthrough-1.png - :alt: Starting position for Dan Troyka's abstract game "Breakthrough" - - Starting position for Dan Troyka's abstract game "Breakthrough" - - -.. sourcecode:: r - - - pmap_piece(df_turkish_draughts(), envir=game_systems(), default.units="in", trans=op_transform, op_scale=0.5) - -.. figure:: man/figures/README-turkish_draughts-1.png - :alt: Starting position for Turkish Draughts - - Starting position for Turkish Draughts - - -.. sourcecode:: r - - - ppgames::cat_piece(df_four_field_kono()) - - -:: - - ## ┌─┰─┰─┰─┐ - ## │⛂┃⛂┃⛂┃⛂│ - ## ┝━╋━╋━╋━┥ - ## │⛂┃⛂┃⛂┃⛂│ - ## ┝━╋━╋━╋━┥ - ## │⛀┃⛀┃⛀┃⛀│ - ## ┝━╋━╋━╋━┥ - ## │⛀┃⛀┃⛀┃⛀│ - ## └─┸─┸─┸─┘ - ## - +.. image:: https://www.repostatus.org/badges/latest/abandoned.svg + :alt: Project Status: Abandoned – Initial development has started, but there has not yet been a stable, usable release; the project has been abandoned and the author(s) do not intend on continuing development. + :target: https://www.repostatus.org/#abandoned +``{tradgames}`` has been superseded by `{ppdf} `_.