Skip to content

Bring a functional programming mindset to R Markdown document generation

License

Notifications You must be signed in to change notification settings

mikemahoney218/heddlr

Repository files navigation

heddlr: Functional Programming Concepts for R Markdown Documents

R build status Codecov Coverage CII Best Practices Package Lifecycle Repo Status CRAN Version AppVeyor build status

Heddlr hex badge

R Markdown is an incredible tool, allowing you to trivially create professional-quality HTML (and PDF and more) documents from simple Markdown documents. However, if those documents have sections which repeat multiple times for different slices of your data, you can wind up spending a lot of time copying and pasting parts of your document. This can make it tricky to update your documents if you decide you want to tweak pieces of your report, and can force you to spend a lot of time updating and double-checking your document if you’re trying to report on information from an changing data set.

heddlr seeks to address these challenges by providing tools to make your R Markdown DRYer (that is, don’t repeat yourself). By making it easier to dynamically piece together components of your document based on your data source, heddlr makes it easier for you to write cleaner documents and create your reports faster.

For examples of what this looks like, check out the intro vignette and the more involved example.

Installation

If the CRAN version badge above is green, you can install the released version of heddlr from CRAN with:

install.packages("heddlr")

You can always get the most up-to-date development version with:

# install.packages("devtools")
devtools::install_github("mikemahoney218/heddlr")