surreal

0.0.2

Create Datasets with Hidden Images in Residual Plots

0packages depend

4.2Kdownloads / year

–test coverage

12/13checks pass

Overview

About

Maintained by James Joseph BalamutaFirst published 2024-09-122 releasesCRAN page ↗GitHub ↗

Implements the "Residual (Sur)Realism" algorithm described by Stefanski (2007) doi:10.1198/000313007X190079 to generate datasets that reveal hidden images or messages in their residual plots. It offers both predefined datasets and tools to embed custom text or images into residual structures. Allowing users to create intriguing visual demonstrations for teaching model diagnostics.

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("surreal", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("coatless-rpkg/surreal")

Development version from coatless-rpkg/surreal. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-surreal

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-surreal

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-surreal

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed).

Health

CRAN checks

1NOTE12OK

Failing flavors

NOTE r-devel-linux-x86_64-debian-gcc

Slowest check: 1.2 min · r-oldrel-windows-x86_64

Code health

None

Tests · ratio 0.00

not tracked

Coverage

100%

Documentation · exports

Dependencies · direct

Check history

NOTE2026-08-01
12 OK · 1 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMEYes · 435 wordsVignettesNopkgdown siteNoNEWSYes · 100% structuredCode of conductNoContributing guideNo

Examples that run: 71%
Documented parameters: 100%
Return-value docs: 100%
References docs: 33%

Downloads

4.2K

CRAN downloads in the past year

Rank #7,669 · ~12/day · ~351/mo

Releases R versions

Daily download trend is not available in this view yet.

21730 days

1.3K90 days

4.2K1 year

Compare downloads with other packages →

Also on119 r2u5 autocran

Repository

GitHub ↗ coatless-rpkg/surreal

19Stars

0Forks

0Open issues

0Open PRs

2Releases

57Commits

1Contributors

diagnostic-plotsr-packageresidual-analysisresidualsrstats

License GPL-3.0 · 57 commits · Last activity 2026-01-11 · 0% stars, 30d

Stars over time

2025-03-29 · 162026-07-07 · 19

Repository practices

Upstream repositoryBeta

5 development-tooling and community-health practices detected across 5 families in the upstream repository

Checks run against github.com/coatless-rpkg/surreal on 2026-07-31.

Continuous integration (1)

GitHub Actions

Reproducibility and dev environment (1)

data-raw/

CRAN release process (1)

cran-comments.md

Docs source (1)

README.Rmd

Show all practices

Lint, format, editor (1)

RStudio project

How this is detected·Detection ruleset v1 (2026-07-18)

Dependencies

Declared dependencies

8 external dependencies (excludes base and recommended)

Depends (1)

R >= 4.3.0

Imports (2)

cli png

LinkingTo (0)

none

Suggests (6)

bmp bslib jpeg rsvg shiny tiff

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

Datasets

People & History

People (1)

Maintainer (1)

James Joseph Balamuta

Author, Maintainer, Copyright holder

Authors (1)

James Joseph Balamuta

Author, Maintainer, Copyright holder

James Joseph Balamuta

Author, Maintainer, Copyright holder

Package Timeline

2 releases. Pick two to compare their code metrics. R releases are shown for context.

R
R 4.6.0 released · 2026-04-24
0.0.2Latest
2026-01-11 · current release · diff ↗
R
R 4.5.0 released · 2025-04-11
0.0.1
2024-09-12
R
R 4.4.0 released · 2024-04-24

Package metadata

First published: 2024-09-12
Total releases: 2 / 2 yrs
License: GPL (>= 3) OSI
Minimum R: ≥ 4.3.0
Bundled data: 167 KB / 2 files
Download size: 967 KB
Installed size: not tracked yet
With dependencies: not tracked yet

Report a problem with this page →