---
title: "plotGrouper"
author:
- name: "John D. Gagnon"
affiliation: University of California, San Francisco
email: john.gagnon.42@gmail.com
package: "plotGrouper"
date: "`r Sys.Date()`"
abstract: >
A shiny app-based GUI wrapper for ggplot with built-in statistical
analysis. Import data from file and use dropdown menus and checkboxes to
specify the plotting variables, graph type, and look of your plots.
Once created, plots can be saved independently or stored in a report that
can be saved as a pdf. If new data are added to the file, the report can be
refreshed to include new data. Statistical tests can be selected and added to
the graphs. Analysis of flow cytometry data is especially integrated with
plotGrouper. Count data can be transformed to return the absolute
number of cells in a sample (this feature requires inclusion of the number of
beads per sample and information about any dilution performed).
output:
BiocStyle::html_document:
toc: true
toc_float: true
vignette: >
%\VignetteIndexEntry{plotGrouper}
%\VignetteEngine{knitr::knitr}
%\VignetteEncoding{UTF-8}
---
```{r logo, echo=FALSE}
htmltools::img(src = knitr::image_uri("logo_small.png"),
alt = 'logo',
style = 'position:absolute;
top:0;
right:0;
padding:10px;
width:150px')
```
# Description
A tool for generating figure-ready graphs from file. It borrows heavily from packages developed
by others, including ggplot2 and dplyr from the tidyverse and batch statistical
calculations from ggpubr.
Plots can be made using combinations of geoms including bar, violin, box,
crossbar, density, point, line, and errorbar.
{width=100%}
<br><br>
{width=100%}
# Prerequisites
1. If you do not already have R installed, or your version is out of date,
download the latest version [Here](https://cran.r-project.org).
+ Optionally, install the latest version of
[RStudio Desktop](https://www.rstudio.com/products/rstudio/#Desktop).
2. Download the package from Bioconductor.
```{r eval = FALSE}
if (!requireNamespace("BiocManager", quietly = TRUE))
install.packages("BiocManager")
BiocManager::install("plotGrouper")
```
+ Alternatively, install the development version of the package from Github
using `BbiocManager`:
```{r eval = FALSE}
BiocManager::install("jdgagnon/plotGrouper")
```
+ Or using `devtools`:
```{r eval = FALSE}
devtools::install_github("jdgagnon/plotGrouper")
```
# Usage
Load the package into the R session.
`library(plotGrouper)`
To initialize the shiny app, paste the following code in your R console
and run it.
`plotGrouper()`
Once the web app opens, you can access the `iris` dataset by clicking the iris
button to learn how to use the app. After the `iris` data loads, the selection
windows will be automatically populated and a graph should be displayed.
The `Raw Data` tab displays the structure of the data loaded. Your file should
be organized in the following way:
```{r, echo=FALSE, fig.align='center'}
knitr::kable(
matrix(c("***Sample***", "***Species***", "***Sepal.Length***",
"setosa_1", "setosa", 5.1,
"setosa_2", "setosa", 4.9,
"versicolor_1", "versicolor", 7,
"versicolor_2", "versicolor", 6.4,
"virginica_1", "virginica", 6.3,
"virginica_2", "virginica", 5.8,
"etc...", "etc...", "etc..."),
ncol = 3, byrow = T),
col.names = c("Unique identifier", "Comparisons", "Variables"),
align = "c")
```
These columns can be titled anything you want but values in the columns are
important.
* The `Unique identifier` column should contain only unique values that
identify each individual sample (e.g., `Sample` within `iris` `Raw Data`).
* The `Comparisons` column should contain replicated values that identify each
individual as belonging to a group (e.g., `Species` within `iris` `Raw Data`).
* The `Variables` column(s) should created for each variable you wish
to plot. The values in these columns must be numeric (e.g., `Sepal.Length`,
`Sepal.Width`, `Petal.Length`, `Petal.Width` within `iris` `Raw Data`)
After importing a data file, a `Sheet` column will be created and populated
with the sheet name(s) from the file if it came from an excel spreadsheet
or the file name if it came from a csv or tsv file.
* The `Variables to plot` selection window is used to choose which variable(s)
to plot (e.g., `Sepal.Width` from the `iris` data). If multiple are selected,
they will be grouped according to the `Independent variable` selected.
* The `Comparisons` selection window is used to choose which column contains
theinformation that identifies which condition each sample belongs to (e.g.,
the `Species` column within the `iris` data).
* The `Independent variable` selection window is used to select how the plots
should be grouped. If `variable` is selected (the default), the plots will be
grouped by the values in `Variables to plot`.
* Use the `Shapes` selector to change the shape of the points for each
comparison variable.
* Use the `Colors` selector to change the point colors for each
comparison variable.
* Use the `Fills` selector to change the fill color for the other geoms being
plotted for each comparison variable.
To prevent the `Shapes`, `Colors`, or `Fills` from reverting to their defaults,
click the `Lock` checkboxes.
Individual plots can be saved by clicking `Save` on the `Plot` tab or multiple
plots may be arranged on a single page by clicking `Add plot to report`.
Clicking this button will send the current plot to the `Report` tab and assign
it a number in the `Report plot #` dropdown menu. To revisit a plot stored in
the `Report` tab, select the plot you wish to restore and click
`Load plot from report`. Changes can be made to this plot and then updated in
the `Report` by clicking `Update plot in report`.
* The statistics calculated for the current plot being displayed in the `Plot`
tab are stored in the `Statistics` tab. These can be saved by clicking the
`Download` button on the `Statistics` tab.
* The `Plot Data` tab contains the reorganized subset of data being plotted.
* The `Raw Data` tab displays the dataframe that was created upon import of the
file along with the automatically created `Sheet` column.
# Session info
Here is the output of `sessionInfo()` on the system on which this package was
developed:
```{r}
sessionInfo()
```
<br><br>
# License
[GNU GPL-3.0-or-later](https://www.gnu.org/licenses/gpl.txt)