GitXplorerGitXplorer
d

funcreporter

public
12 stars
1 forks
2 issues

Commits

List of commits on branch master.
Unverified
9f5114983e6cfeab45f17e2598e3519e77e699ed

using onexit

ddaranzolin committed 4 years ago
Unverified
5f69cb6bcc53291980ee1457aacc450d734fb4ae

reordered file copy and removal

ddaranzolin committed 4 years ago
Unverified
2de30a9a5df8fa1a3670d82d012c9d8b94a1391a

roxygen update

ddaranzolin committed 4 years ago
Unverified
ec7f580525a3459f04274f6d608fe60ec658a918

added tests

ddaranzolin committed 4 years ago
Unverified
068fd2d7108d6b875f77a34b1b88e860a1ca75f5

print_report_descriptions now shows param info

ddaranzolin committed 4 years ago
Unverified
0aa1366dcc0fb94237cb412cf2055d53a7065525

update README again

ddaranzolin committed 4 years ago

README

The README file for this repository.

funcreporter

CRAN log Travis build status

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:

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:

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.

funcreporter(
  template_name = "Sample 1", 
  output_file = "versicolor-report",
  params = list(species = "versicolor")
  )

Multiple reports

Render more than one report:

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