Add hex logo, hex text as demo data (#26)

* Add logo text matrix as example dataset

* Add hex logo

Author: matt-dray

R/click.R

@@ -180,7 +180,7 @@ edit_pixels <- function(
     colours   <- get_greys(n_states)  # gradated colours from white to dark grey
   }
 
-  .check_colours_unique(m, colours)
+  # .check_colours_unique(m, colours)
 
   .plot_canvas(m, n_states, colours)
   if (grid) .add_grid(m)

R/data.R

@@ -1,20 +1,16 @@
-#' Example Sprite Matrix: Pokémon
+#' Example Sprite Matrix: 'pixeltrix' Package Logo Text
 #'
-#' A matrix output from \code{\link{click_pixels}} that represents the pixels of
-#' a player sprite from Pokémon.
+#' A matrix output from \code{\link{click_pixels}} that represents the
+#' text of the pixeltrix package logo, which is the word 'pixeltrix' written
+#' in a font with letters that are 3 by 3 pixels.
 #'
 #' @examples \dontrun{
 #'     # Plot the matrix as an image
-#'     draw_pixels(
-#'       m = pixeltrix::pkmn_sprite,
-#'       colours = c("#9bbc0f", "#8bac0f", "#306230")
-#'     )
+#'     draw_pixels(m = pixeltrix::logo)
 #' }
 #'
-#' @format A matrix with 16 rows and 14 columns, taking integers from 0 to 2.
-#'
-#' @source Hand-copied from Pokemon (1996), The Pokemon Company.
-"pkmn_sprite"
+#' @format A matrix with 10 rows and 21 columns, taking integers from 0 to 2.
+"logo"
 
 #' Example Sprite Matrix: Mario
 #'
@@ -23,11 +19,10 @@
 #' the walk cycle.
 #'
 #' @examples \dontrun{
-#'     # Write a list of matrices to a gif
+#'     # Write the list of matrices to a gif
 #'     gif_pixels(
 #'       frames = pixeltrix::mario_frames,
-#'       colours = c("#8861FE", "#F6B95B", "#FFFFFF", "#29A41F"),
-#'       file = "super-mario.gif",
+#'       file = "mario.gif",
 #'       delay = 0.15  # passed to gifski::save_gif()
 #'     )
 #' }
@@ -37,3 +32,21 @@
 #'
 #' @source Super Mario Bros (1983), Nintendo.
 "mario_frames"
+
+#' Example Sprite Matrix: Pokémon
+#'
+#' A matrix output from \code{\link{click_pixels}} that represents the pixels of
+#' a player sprite from Pokémon.
+#'
+#' @examples \dontrun{
+#'     # Plot the matrix as an image
+#'     draw_pixels(
+#'       m = pixeltrix::pkmn_sprite,
+#'       colours = c("#9bbc0f", "#8bac0f", "#306230")
+#'     )
+#' }
+#'
+#' @format A matrix with 16 rows and 14 columns, taking integers from 0 to 2.
+#'
+#' @source Hand-copied from Pokemon (1996), The Pokemon Company.
+"pkmn_sprite"

README.Rmd

@@ -16,7 +16,7 @@ knitr::opts_chunk$set(
 library(pixeltrix)
 ```
 
-# pixeltrix
+# pixeltrix <a href="https://github.com/matt-dray/pixeltrix"><img src="man/figures/logo.png" align="right" height="139" /></a>
 
 <!-- badges: start -->
 [![Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)

README.md

@@ -1,7 +1,7 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# pixeltrix
+# pixeltrix <a href="https://github.com/matt-dray/pixeltrix"><img src="man/figures/logo.png" align="right" height="139" /></a>
 
 <!-- badges: start -->