-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
99 lines (65 loc) · 4.35 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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
---
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%"
)
```
# FastRPA
<!-- badges: start -->
<!-- badges: end -->
## Description
The goal of FastRPA is to speed up the interpretation time of root length measurement data.
Manually selecting, organizing and analysing data of potentially thousands of root measurements are time consuming. FastRPA enables a semi-automatic solution, enabling the user to select root length measurements from the multiple output file of FastIDR imageJ tool, thereby centralizing data from numerous data files. This package was developed using `R version 4.1.1 (2021-08-10`, `Platform: x86_64-apple-darwin17.0 (64-bit)` and `Running under: macOS Big Sur 11.4`
## Installation
You can install the development version of FastRPA like so:
``` r
require("devtools")
devtools::install_github("ErikEnsminger/FastRPA", build_vignettes = TRUE)
library("FastRPA")
```
Shiny app:
``` r
FastRPA::runFastRPA()
```
## Overview
``` r
ls("package:FastRPA")
data(package = "FastRPA")
```
Look into the vignettes for a specific example process flow:
``` r
browseVignettes("FastRPA")
```
An overview of the pacakge is illustrated below.
<div style="text-align:center"><img src="./inst/extdata/package_overview.png" width="600"/>
<div style="text-align:left">
FastRPA contains 3 functions: _*filterData*_, _*analyseRootData*_, and _*createRootBarG*_.
\n
_*filterData*_ is the first function in the process. As input for _*filterData*_ the user must specify a column index of the root measurements to be extracted, the .csv input file (Fig.1 A.i. and Fig.1 A.ii.) , an output file, and the Treatment type used on the roots.It will allow the user to select different Root length measurements and the corresponding Gene Lines from a user defined .csv files.
_*analyseRootData*_ takes in an input file (prefferably the output file from _*filterData*_ Fig. 1B), the control Treatment, and an output file. _*analyseRootData*_ will then based on the indciated controlTreatment normalize each of the treatment data and output the data to the desired output file (Fig. 1C).
_*createRootBarG*_ takes in an input file (the output file from _*analyseRootData*_ (Fig.1C)). *createRootBarG*_ creates a bar plot of the specified treatments and their corresponding gene lines (Fig. 1.D).
An overview of the package R functions illustrated below in Figure 1.:
<div style="text-align:center"><img src="./inst/extdata/FastRPA_overview.png" width="600"/>
<div style="text-align:left">
## Contributions
The author of this package is Erik Ensminger. The _*filterData*_ function makes use of split function of the `plyr` R package for binding data frames.
The _*createRootBarG*_ function makes use of the `reshape2` R package for the melting dataframes. In addition, _*createRootBarG*_ function makes use of the `ggplot` R package for plotting the Bar graph of the root length data.
## References
Steipe B., ABC project (.utility 4.07) A Bioinformatics Course: Applied Bioinformatics http://steipe.biochemistry.utoronto.ca/abc/index.php/Bioinformatics_Main_Page
R Core Team (2021). R: A language and environment for statistical computing. R Foundation for Statistical Computing, Vienna, Austria. https://www.R-project.org/
Wickham H (2007). “Reshaping Data with the reshape Package.” *Journal of Statistical Software*, 21(12), 1–20. http://www.jstatsoft.org/v21/i12/.
Wickham H (2011). “The Split-Apply-Combine Strategy for Data Analysis.” *Journal of Statistical Software*, 40(1), 1–29. http://www.jstatsoft.org/v40/i01/.
Wickham H (2016). ggplot2: Elegant Graphics for Data Analysis. *Springer-Verlag* New York. ISBN 978-3-319-24277-4, https://ggplot2.tidyverse.org.
Wickham, H. and Bryan, J. (2019). *R Packages* (2nd edition). Newton, Massachusetts: O’Reilly Media. https://r-pkgs.org/
## Acknowledgements
This package was developed as part of an assessment for 2021 BCB410H: Applied Bioinfor- matics, University of Toronto, Toronto, CANADA.
## Citation for Package
<div style="text-align:left">
[Ensminger, E. (2021) FastRPA (Root length measurement analysis tool): an R package for organizing, analysing and visualization of plant root length measurement data)
](https://github.com/ErikEnsminger/FastRPA)