contextual

Context-aware messaging and hierarchical document structuring for R.

Installation

# Install from local directory
devtools::install("~/MEGA/repo/macroverse/contextual")

Features

• Hierarchical Titles: Automatic numbering (1, 1.1, 1.1.1) with smart depth detection
• Formatted Messages: Consistent error, warning, alert, and success messages
• Context-Aware Text: Automatic indentation based on section depth
• Smart Reset Detection: Handles script re-execution and console calls

Usage

library(contextual)

# Create hierarchical document structure
cx_title("Data Analysis")              # 1. DATA ANALYSIS
cx_title("Load Data", level_adjust=1)  # 1.1. Load Data
cx_text("Loading datasets...")         #     Loading datasets...

# Formatted messages
cx_success("Data loaded successfully")
cx_warn("Missing values detected")
cx_alert("Processing large dataset")

# Heading functions
cx_h1("Results")                       # 2. RESULTS
cx_h2("Summary Statistics")            # 2.1. Summary Statistics
cx_h3("Descriptive Stats")             # 2.1.1. Descriptive Stats
cx_h4("Details")                       # → Details

Configuration

# Control debug output
.contextual_env$debug <- FALSE

# Control auto-numbering
.contextual_env$auto_number <- "all"    # all functions auto-number
.contextual_env$auto_number <- "title"  # only cx_title auto-numbers
.contextual_env$auto_number <- "none"   # no auto-numbering

License

Licensed under AGPL-3.0. Part of the macroverse R ecosystem.