-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
74 lines (53 loc) · 2.22 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# SuperPlotR <a href="https://quantixed.github.io/SuperPlotR/"><img src="man/figures/logo.png" align="right" height="139" alt="SuperPlotR website" /></a>
<!-- badges: start -->
[](https://doi.org/10.5281/zenodo.14606751)
<!-- badges: end -->
The goal of SuperPlotR is to allow the user to easily generate SuperPlots in R.
SuperPlots are a way to visualise data in a way that emphasises the experimental
reproducibility.
You can read more about SuperPlots in the
[original paper](https://doi.org/10.1083/jcb.202001064):
Lord, S.J., Velle, K.B., Mullins, R.D. & Fritz-Laylin, L.K. (2020)
**SuperPlots: Communicating reproducibility and variability in cell biology.**
_J. Cell Biol._ 219(6):e202001064
## Installation
You can install the development version of SuperPlotR from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("quantixed/SuperPlotR")
```
## Example
A simple example of how to use SuperPlotR is shown below:
```{r example}
library(SuperPlotR)
superplot(lord_jcb, "Speed", "Treatment", "Replicate", ylab = "Speed (µm/min)")
```
The data used in this example is included in the package and is from the original
paper.
To generate a SuperPlot, you need a data frame that has at least three columns.
These columns are:
1. the variable that is measured in the experiment,
2. the experimental condition,
3. the experimental repeat that the measurment comes from.
The `superplot` function takes the data frame, the names of these three columns,
and is further customisable with additional arguments.
See `vignette("SuperPlotR")` for more examples, or
`vignette("advanced")` for more advanced usage.
## More information
My SuperPlot package for IGOR Pro is available
[here](https://github.com/quantixed/SuperPlot)
A popular web-based app for generating SuperPlots, developed by
[Joachim Goedhart](https://github.com/JoachimGoedhart) is available
[here](https://huygens.science.uva.nl/SuperPlotsOfData/)