https://github.com/mikemahoney218/heddlr

Bring a functional programming mindset to R Markdown document generation
https://github.com/mikemahoney218/heddlr

cran heddlr r r-package rmarkdown rstats

Last synced: 3 months ago
JSON representation

Bring a functional programming mindset to R Markdown document generation

• Host: GitHub
• URL: https://github.com/mikemahoney218/heddlr
• Owner: mikemahoney218
• License: other
• Created: 2019-11-18T02:01:44.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-06-19T14:01:05.000Z (over 3 years ago)
• Last Synced: 2024-07-10T12:48:11.588Z (4 months ago)
• Topics: cran, heddlr, r, r-package, rmarkdown, rstats
• Language: R
• Homepage: https://mikemahoney218.github.io/heddlr/
• Size: 9.31 MB
• Stars: 23
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
---

output: md_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# heddlr: Functional Programming Concepts for R Markdown Documents

[![R build status](https://github.com/mikemahoney218/heddlr/workflows/R-CMD-check/badge.svg)](https://github.com/mikemahoney218/heddlr/actions)

[![Codecov Coverage](https://codecov.io/gh/mikemahoney218/heddlr/branch/master/graph/badge.svg)](https://codecov.io/gh/mikemahoney218/heddlr?branch=master)

[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3535/badge)](https://bestpractices.coreinfrastructure.org/projects/3535)

[![Package Lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/)

[![Repo Status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/)

[![CRAN

Version](https://www.r-pkg.org/badges/version/heddlr)](https://cran.r-project.org/package=heddlr)

[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/mikemahoney218/heddlr?branch=master&svg=true)](https://ci.appveyor.com/project/mikemahoney218/heddlr)



[R Markdown](https://github.com/rstudio/rmarkdown) 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](https://r4ds.had.co.nz/functions.html#when-should-you-write-a-function)).

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](https://mikemahoney218.github.io/heddlr/articles/modular-reporting-with-heddlr.html) 

and the [more involved example.](https://mikemahoney218.github.io/heddlr/flights-example/flexdashboards-with-heddlr.html) 

## Installation

If the CRAN version badge above is green, you can install the released version 

of heddlr from [CRAN](https://CRAN.R-project.org) with:

``` r

install.packages("heddlr")

```

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

``` r

# install.packages("devtools")

devtools::install_github("mikemahoney218/heddlr")

```