Flexible and Customisable Logging System
Overview
A comprehensive logging framework for R applications that provides hierarchical logging levels, database integration, and contextual logging capabilities. The package supports 'SQLite' storage for persistent logs, provides colour-coded console output for better readability, includes parallel processing support, and implements structured error reporting with 'JSON' formatting.
BREAKING CHANGES
- **N/A**
NEW FEATURES
1. **Hierarchical Logging Levels:** Implemented multiple logging levels (ERROR, WARNING, INFO, OFF) to control message output granularity.
2. **File-Based Logging:** Added support for logging messages to user-specified file paths, enabling persistent log storage.
3. **Database Logging Integration:** Integrated database support using DBI and RSQLite for efficient and scalable log management.
4. **Contextual Logging:** Introduced contextual logging capabilities to attach metadata to log entries, enhancing traceability.
5. **Customisable Message Formatting:** Enabled custom message formatting functions to tailor log output according to user preferences.
6. **Coloured Console Output:** Incorporated crayon for colour-coded console messages, improving readability and distinguishing log levels.
7. **Parallel Processing Support:** Developed the messageParallel function to handle message output from parallel processes seamlessly.
8. **Structured Error Reporting:** Implemented JSON formatting for structured error reporting, facilitating easier parsing and analysis of log data.
9. **Comprehensive Documentation:** Created detailed vignettes and function documentation to guide users through package features and usage scenarios.
Show all changes in 1.0.0Hide the rest of the changes in 1.0.0
IMPROVEMENTS
1. **Enhanced Package Structure:** Optimized the internal organization of the package for better maintainability and scalability.
2. **Robust Error Handling:** Improved error handling mechanisms to provide more informative and consistent error messages across the package.
3. **Performance Optimization:** Streamlined logging operations to minimize performance overhead, ensuring efficient execution even in high-throughput environments.
4. **Refined R6 Class Implementation:** Strengthened the Stenographer R6 class for more reliable and flexible logging functionality.
5. **Dependency Management:** Managed package dependencies effectively, ensuring that all required packages are correctly specified and utilized within the package codebase.
DOCUMENTATION
1. **Detailed Vignettes:** Developed comprehensive vignettes demonstrating various use cases, configuration options, and best practices for using the stenographer package.
2. **Enhanced Function Documentation:** Expanded function documentation with extensive examples and clearer explanations to assist users in understanding and utilizing package functions effectively.
3. **Comprehensive README:** Updated the README.md with installation instructions, feature overviews, and quick start guides to provide users with a clear entry point to the package.
DEVELOPMENT
1. **Continuous Integration Setup:** Established GitHub Actions workflows for automated testing, coverage reporting, and package checks to ensure code quality and reliability.
2. **Comprehensive Test Suite:** Implemented a robust test suite using testthat to validate package functionality and prevent regressions.
3. **CRAN Policy Compliance:** Ensured that the package adheres to CRAN submission policies, facilitating smooth package release and maintenance.
4. **Dependency Management:** Managed package dependencies effectively, ensuring that all required packages are correctly specified and utilized within the package codebase.
NOTES
1. **First Official Release:** This is the inaugural release of the stenographer package, marking its availability for CRAN submission and general use.
2. **R Version Compatibility:** The package is compatible with R versions 4.1.0 and above, ensuring broad usability across different R environments.
From NEWS.md in the release
Install
Health
- OK13 OK2026-08-04
- NOTE12 OK, 1 NOTE2026-08-01
- OK14 OK2026-04-19
- ERROR13 OK, 1 ERROR2026-04-18
- OK14 OK2026-03-10
Documentation
- Help pages
- 7 (1 internal)
- Examples that run
- 100%6 run in a plain check
- Exported functions with examples
- 100%
- Documented parameters
- 100%
- Return-value docs
- 67%
- Help pages citing references
- 0%
- Donate HTML
- Getting started with stenographer HTML
Downloads
Repository
- PRs merged (all time)
- 100%
- Median days to close, 50 most recently updated closed issues
- 147
- Median days to close, 50 most recently updated closed PRs
- 0
Stars over time
Releases over time
Issues over time
PRs over time
11 development-tooling and community-health practices detected across 5 families in the upstream repository
Checks run against github.com/dereckmezquita/stenographer on 2026-10-18.
The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel
The repository owner accepts GitHub Sponsors
GitHub Pages site last deployed 2025-05-12 · The repository has a site deploy workflow
Show all practicesHide 1 practice
Dependencies
Code & Tests
People & History
- RR 4.6.0 released · 2026-04-24
- RR 4.5.0 released · 2025-04-11
- 1.0.0Latest2025-01-16 · current release
- RR 4.4.0 released · 2024-04-24
Package metadata
- First published
- 2025-01-16
- Total releases
- 1 / 1 yrs
- License
- MIT + file LICENSE OSI
- Minimum R
- ≥ 4.1.0
- Download size
- 34 KB
Cite
Cite this package
Run in R for the authors' entry:
citation("stenographer")The package provides a citation file, so citation() returns the authors' own entry.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-22, which the citation names so these numbers can be found later. More on citing and the projects behind them.