kstreet13 / mazing Goto Github PK

It would be great if there was a way to plot mazes with ggplot2, but unfortunately I am not the right person for that job. If anybody reading this has the know-how and wants to become an author on this package, please let me know!

Fun package!

It would be helpful if there were a way to indicate to the person solving the maze where they should start and end.

For example, the following plots a nice maze and solution, however the start and end point are not obvious without showing the path:

m <- maze(35,100)
p <- solve_maze(m, start = 'left', end = 'right')
plot(m, lwd = 1, walls = TRUE)
lines(p, lwd = 3, col = 2)

This enhancement could be implemented in a number of ways. I can think of two:

1. Make a break in the wall at the start and end points
2. Plot user-defined symbols for start and end outside the maze in the right locations (along with (1) if walls are drawn)

To do this with existing functionality I would need to save the maze as an image and then post-process it in an image editor to do (1) and/or (2).

The above is based on mazing version 1.0.2.

• I think usethis::use_pkgdown_github_pages() will automatically set up everything including the relevant Github Actions needed to automatically build such a website after repo pushes using a github.io url: https://usethis.r-lib.org/reference/use_pkgdown.html
• Alternatively you could build a website locally in a directory using: pkgdown::build_site() and then rsync the files to a website directory you control (this is what I do with my own packages)
• A good idea to add links to this site on the DESCRIPTION and upper right description on Github

• The development version of {bittermelon} recently added an as_bm_bitmap.maze() S3 method.
• Unsure whether you'd want to add {bittermelon} to {mazing}'s Imports or Suggests fields but if you do you could add a print.maze() method to print {mazing} mazes in the terminal.
• This seem to render similarly to {mazing}'s plot.maze() method (i.e. flip the matrices to "plot" in similar ways)

# remotes::install_github("trevorld/bittermelon")
print.maze <- function(x, ..., walls = FALSE, start = NULL, end = NULL) {
    stopifnot(requireNamespace("bittermelon", quietly = TRUE),
              packageVersion("bittermelon") >= "1.2.0-2")
    bm <- bittermelon::as_bm_bitmap(x, walls = walls, start = start, end = end)
    print(bm, ...)
}

set.seed(42)
m <- mazing::maze(16L, 32L) 
print(m, fg = "red", bg = "black", compress = "v")

print(m, start = "top", end = "bottom",
      px = c("\u2588", "\u2588", "\u25cf"), 
      fg = c("black", "white", "red"), bg = "white")