Package {escapeR}

Escape Room Adventures for Learning R in Ecological Statistics

Description

A lightweight classroom game where students learn R by solving ecological-statistics puzzles inside a virtual escape room.

Details

Call escape() in an interactive R session, solve each room with ordinary R commands, and use submit() to unlock the next task.

To learn how to play, see vignette("getting-started-with-escapeR", package = "escapeR"). To create themed rooms or contributor room packs, see vignette("creating-themed-escape-rooms", package = "escapeR").

Build and Register escapeR Rooms

Description

Helpers for composing custom escape-room sequences and adding contributed rooms or room packs.

Usage

build_escape(rooms = .builtin_room_ids())

list_escapes()

new_room(id, module, title, learning_goal, introduction, challenge,
  hints, correct_result = NULL, checker = NULL, success, failure = NULL)

new_room_pack(id, title, description, rooms, escapes)

register_room_pack(pack, replace = FALSE)

register_rooms(..., replace = FALSE)

Arguments

Value

build_escape() returns an escape sequence object for escape(). list_escapes() returns a data frame of registered sequences. new_room() returns a modular room object. new_room_pack() returns a shareable room pack. Registration helpers return IDs invisibly.

Examples

build_escape(c("console", "vector"))$room_ids
list_escapes()
room <- new_room(
  id = "meanroom", module = "Arithmetic", title = "A field sample",
  learning_goal = "Calculate a mean", introduction = "Three samples await.",
  challenge = "Submit the mean of 1, 2 and 3.", hints = "Use mean().",
  correct_result = 2, success = "The door opens."
)
room$id

Delete a Saved Player Profile

Description

Removes a saved profile and closes the active game if it uses that profile.

Usage

delete_progress(player = .state$player)

Arguments

Details

Progress is stored in the per-user directory returned by tools::R_user_dir(). Set options(escapeR.progress_dir = path) to select another directory. Delete profiles when no longer needed. Player filenames are case-insensitive and punctuation is replaced by underscores.

Value

Invisibly returns whether a saved file was removed.

Examples

local({
  path <- tempfile("escapeR-demo-")
  old <- options(escapeR.progress_dir = path)
  on.exit(options(old))
  on.exit(unlink(path, recursive = TRUE), add = TRUE)
  escape(player = "demo", reset = TRUE)
  submit(70)
  delete_progress("demo")
})

Start or Resume an escapeR Game

Description

Start a new game or resume saved progress for a returning player.

Usage

escape(player = NULL, reset = FALSE, escape = NULL)

Arguments

Value

Invisibly returns the current progress list.

Helper Data Functions

Description

Small helper functions used by the escape-room puzzles.

Usage

escapeR_file(filename)

survey_counts()

Arguments

Value

escapeR_file() returns a file path, and survey_counts() returns a data frame.

Examples

head(survey_counts())
read.csv(escapeR_file("survey_counts.csv"))

Play the escapeR Game

Description

Functions used by students to move through the virtual escape room.

Usage

play()

submit(answer)

hint()

status()

reset_game(player = NULL)

list_rooms()

Arguments

Value

play(), hint(), status(), and reset_game() return useful game objects invisibly. submit() invisibly returns whether the answer was correct. list_rooms() returns a data frame with room IDs, modules, titles, and learning goals.

Examples

head(list_rooms())