Skip to content

roseneath12/reportmagic

Repository files navigation

reportmagic

R-CMD-check

The reportmagic package provides small, expressive helper functions that make it easier to write clear, human‑readable analytical reports. It focuses on three core tasks that frequently appear in everyday data communication:

  • extracting a single numeric value from a dataset,
  • describing numbers in natural language,
  • formatting numbers cleanly for publication.

These helpers are designed to be simple, predictable, and easy to combine inside .Rmd and .qmd reports.

Why this package exists

I created reportmagic with two intentions.

First, I wanted to learn how to build an R package completely from scratch: structure, documentation, testing, GitHub workflows, everything. This project became a practical way to understand the full lifecycle of package development.

Second, I wanted a home for the small helper functions I use in automated Quarto reports. Packaging them together makes it easier to reuse them across projects and to refine them over time.

Installation

You can install the development version from GitHub:

# install.packages("remotes")
remotes::install_github("roseneath12/reportmagic")

Contributing

Contributions are warmly welcomed. If you have ideas, improvements, or suggestions, feel free to open an issue or submit a pull request.

Code of Conduct

Please note that this project is released with a Contributor Covenant Code of Conduct.
By participating in this project, you agree to abide by its terms.

About

Tools for Narrative-Friendly Reporting

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Code of conduct

Stars

Watchers

Forks

Packages

 
 
 

Contributors