charisma (version 1.0.0)

mosaic: Create a color mosaic visualization from color proportions

Description

This function generates a randomized mosaic grid visualization representing the proportions of different colors, useful for visually displaying color composition in a standardized format.

Usage

mosaic(
  color.props,
  size = 10,
  out.path = normalizePath("~"),
  out.prefix = "charisma_mosaic",
  verbose = TRUE
)

Value

Character string containing the full path to the saved PNG file.

Arguments

color.props

List of color proportion objects, where each element contains:

• hex: Hex color code (e.g., "#FF0000")

• color: Color name

• prop: Proportion value (all proportions must sum to 1)

size

Integer specifying the dimensions of the mosaic grid (size x size). Default is 10 (resulting in a 10 x 10 = 100 cell mosaic).

out.path

Character string specifying the directory path for saving the output PNG file. Default is the user's home directory.

out.prefix

Character string prefix for the output filename. Default is "charisma_mosaic".

verbose

Logical. If TRUE, prints the full output path. Default is TRUE.

Details

The mosaic function creates a visual representation of color proportions by:

1. Allocating grid cells proportional to each color's proportion

2. Randomly shuffling cell positions to create a mosaic pattern

3. Saving the result as a PNG file with an informative filename

The output filename automatically encodes the hex codes, color names, and proportions for documentation purposes.

See Also

charisma for generating color classifications

Examples

# Create a mosaic from color proportions
colors <- list(
  list(hex = "#FF0000", color = "red", prop = 0.4),
  list(hex = "#00FF00", color = "green", prop = 0.3),
  list(hex = "#0000FF", color = "blue", prop = 0.3)
)
mosaic(colors, size = 10, out.path = tempdir())