https://github.com/daranzolin/funcreporter

Automate RMarkdown Reporting :sparkles: :fire: :dancer:
https://github.com/daranzolin/funcreporter

rmarkdown rmarkdown-templates rstats

Last synced: 4 months ago
JSON representation

Automate RMarkdown Reporting :sparkles: :fire: :dancer:

• Host: GitHub
• URL: https://github.com/daranzolin/funcreporter
• Owner: daranzolin
• License: other
• Created: 2019-12-10T20:38:48.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-03-29T23:41:59.000Z (about 4 years ago)
• Last Synced: 2024-08-13T07:13:23.616Z (8 months ago)
• Topics: rmarkdown, rmarkdown-templates, rstats
• Language: R
• Homepage:
• Size: 316 KB
• Stars: 12
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - daranzolin/funcreporter - Automate RMarkdown Reporting :sparkles: :fire: :dancer: (R)

README

        
# funcreporter

![](https://camo.githubusercontent.com/ea6e0ff99602c3563e3dd684abf60b30edceaeef/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6966656379636c652d6578706572696d656e74616c2d6f72616e67652e737667)

![CRAN log](http://www.r-pkg.org/badges/version/funcreporter)

[![Travis build status](https://travis-ci.org/daranzolin/funcreporter.svg?branch=master)](https://travis-ci.org/daranzolin/funcreporter)

The goal of funcreporter is to interface with your parameterized Rmarkdown templates in a more intimate (and funky) fashion. Namely, via the `funcreporter()` function. This means loops and automation, coding instead of clicking.

## Installation

You can install the released version of funcreporter from GitHub with:

``` r

remotes::install_github("ir-sfsu/funcreporter")

```

## Setup

Inform `funcreporter` of your reporting package (this is the package that contains your Rmarkdown templates). Here we'll use the `funcreports` sample package:

``` r

remotes::install_github("daranzolin/funcreports")

library(funcreporter)

set_funcreporter_pkg("funcreports")

```

## Example

`funcreporter` is a wrapper around `rmarkdown::render` that locates package templates and renders output to your working directory.

``` r

funcreporter(

  template_name = "Sample 1", 

  output_file = "versicolor-report",

  params = list(species = "versicolor")

  )

```

## Multiple reports

Render more than one report:

``` r

species <- unique(iris$Species)

funcreporter(

  template_name = "Sample 1",

  output_file = paste0(species, "-report"),

  params = list(species = species, breaks = 15, plot_title = paste(species, "Distribution"))

)

```

Feel the power! Three reports for three species isn't much, but how about 50 reports for 50 clients? Get funky.

## The Gadget

Use `funcreporterGadget` for GUI reporting

![](inst/funcreporterGadget.png)