README.md

In cramirezs/wreportr: Summarise Your Folders

wreportr

The goal of wreportr is to make a summary of your pipeline easier.

The central concept is having a set of “steps” your analysis follows, but it is not limited to a sequential design.

A bit late for a meeting to update and want something nice to show? In a few minutes, you can create a nice website for your project.

Installation

You can install the developing version of wreportr from GitHub with:

devtools::install_github("cramirezs/wreportr", ref = "main")

Examples

There are several ways of generating your HTML report, but the input essentially looks like this:

---
title: "My side project"
output: html_document
steps:
  metadata: /Users/ciro/Documents/liai/covid19/part2/metadata_library.csv
  step_1: /Users/ciro/Documents/liai/covid19/literature
  step_2: /Users/ciro/Documents/liai/covid19/part1
  step_3: /Users/ciro/Documents/liai/covid19/part2
  step_4: /Users/ciro/Documents/liai/published/covid19
...

cramirezs/wreportr documentation built on Dec. 19, 2021, 6:09 p.m.