README.md
In Vessy/Rmaze: A package for generating mazes

Rmaze

To install the Rmaze package, run the following command:

devtools::install_github("Vessy/Rmaze")
library("Rmaze")

Rmaze is a package that provides options to generate and plot mazes in R.

Currently, the package provides options to create a maze using the recursive backtracker (modified depth-first search), Kruskal's, and Prim's algorithms. These algorithms create "perfect" mazes, i.e., mazes without loops and without inaccessible areas. Such mazes have exactly one solution (there is exactly one path from each maze cell to another maze cell).

All mazes are represented in a form of connected graphs, where the edges represent possible wall sites and the nodes represent maze cells. All graph manipulations are based on the functions provided in the igraph package.

A maze generated using a recursive backtracker algorithm (randomized version of depth-first search algorithm)

The package also provides options to plot step-by-step maze generating process and the maze solution.

A step-by-step illustration of maze creation using using a recursive backtracker algorithm. White cells are unvisited maze cells, red cells are the maze cells on stack, and the blue cells are the maze cells that have been visited and removed from the stack)

The maze solution is defined as the shortest path between the start and end maze cells:

A maze solution

Finally, the package provides an option to create imperfect mazes. These mazes are created by randomly adding or removing specified percentages of maze walls from the perfect mazes. In the process of randomization, the algorithm ensures that the added and removed walls do not interfere with the existence of the maze solution. The imperfect mazes contain loops, inaccessible areas, and may have more than one solution.

An imperfect maze created by randomly adding or removing 20% of walls