Generation of R Analysis Reports using RMarkdown
| Audience | Computational Skills | Prerequisites | Duration |
|---|---|---|---|
| Anyone | Beginner/Intermediate R | Working knowledge of R/RStudio | 3 hour workshop |
Description
This repository has teaching materials for a 3 hour, hands-on Generation of R Analysis Reports using RMarkdown workshop led at a relaxed pace.
Reproducible research is as important for computational analysis as it is at the bench. Integrating your R data analyses into a report format allows for easy retrieval of the packages/versions and code used to generate your results and figures. It allows for efficient communication of your results with your collaborators. The knitr R package allows for the easy generation of professional reports for any R analysis, while allowing for customization and easy revision. In this 3-hour workshop, we will cover the simple RMarkdown syntax and explore options for customizing your reports.
Learning Objectives
- Understand Rmarkdown syntax and available features: Exploring the syntax of the Rmarkdown language and different available features.
- Utilize
knitrfor report generation: Practicing withknitrand differentknitroptions for customizing reports.
These materials are developed for a trainer-led workshop, but also amenable to self-guided learning.
Contents
| Estimated Duration | Lesson | Instructor |
|---|---|---|
| 13:00 - 13:10 | Workshop Introduction | Mary |
| 13:10 - 13:30 | Introduction to Reproducibility | Meeta |
| 13:30 - 14:15 | RMarkdown Basics | Mary |
| 14:15 - 14:20 | Break | |
| 14:20 - 15:05 | RMarkdown Intermediate | Meeta |
| 15:05 - 15:50 | Practice with RMarkdown | Mary |
| 15:50 - 16:00 | Wrap-up | Mary |
Setup and Installation Requirements
Download the most recent versions of R and RStudio for your laptop:
Install the below packages on your laptop from CRAN. You DO NOT have to go to the CRAN webpage; you can install as follows:
install.packages("tidyverse")
install.packages("pheatmap")
Load the libraries to ensure the packages properly installed:
library("tidyverse")
library("pheatmap")
Answer keys
Resources
R Markdown
- knitr in a knutshell
- knitr book
- knitr examples
- knitr vignettes
- knitrBootstrap package for example reports and for adding themes
- The DT package - for fancy tables in Rmarkdown
Reproducibility guidelines
These materials have been developed by members of the teaching team at the Harvard Chan Bioinformatics Core (HBC). These are open access materials distributed under the terms of the Creative Commons Attribution license (CC BY 4.0), which permits unrestricted use, distribution, and reproduction in any medium, provided the original author and source are credited.