This repository has been archived by the owner on Sep 19, 2023. It is now read-only.
forked from odea-project/StreamFind
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
57 lines (39 loc) · 3.54 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
---
output: github_document
bibliography: inst/REFERENCES.bib
---
<!-- 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%"
)
```
# streamFind
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
<!-- badges: end -->
The streamFind project, entitled "Flexible data analysis and workflow designer to identify chemicals in the water cycle", is funded by the [Bundesministerium für Bildung und Forschung (BMBF)](https://www.bmbf.de) and is a cooperation between the [Institut für Energie- und Umwelttechnik e. V. (IUTA)](https://www.iuta.de), the [Forschungszentrum Informatik (FZI)](https://www.fzi.de/) and supporting partners. The goal of the streamFind project is the development and assembly of data processing workflows for mass spectrometry and spectroscopy and the application of the workflows in environmental and quality studies of the water cycle. The streamFind aims to stimulate the use of advanced data analysis (e.g., non-target screening, statistical analysis, etc.) in routine studies, promoting standardization of data processing and structure and easing the retrospective evaluation of data. The streamFind platform is directed to academics but also technicians, due to the aspired comprehensive documentation, well categorized set of integrated modular functions and the graphical user interface. The streamFind development is ongoing, please [contact us](mailto:cunha@iuta.de) for questions or collaboration.
```{r, echo=FALSE, out.width = '100%', fig.align='center'}
knitr::include_graphics("man/figures/logo_group.png")
```
# streamFind R package
The back-end framework of [streamFind](https://github.com/ricardobachertdacunha/streamFind) is an R package.
## Installation
For installation of the streamFind R package, it is recommended to first install the dependencies. Besides [R](https://cran.r-project.org/) and [RTools](https://cran.r-project.org/bin/windows/Rtools/) (the latter is only recommended for Windows users), the streamFind depends on the [patRoon](https://github.com/rickhelmus/patRoon) R package and its dependencies. The patRoon R package combines several tools for basic and advanced data processing and can be used interchangeably with the streamFind R package. Installation instructions for patRoon and its dependencies can be found [here](https://rickhelmus.github.io/patRoon/handbook_bd/manual-installation.html#r-prerequisites).
Then, the streamFind R package can be installed from the GitHub repository.
```{r install-streamfind, eval=FALSE}
remotes::install_github("ricardobachertdacunha/streamFind", dependencies = TRUE)
```
The supplementary [streamFindData](https://github.com/ricardobachertdacunha/streamFindData) R package holds the data used in examples and other documentation assets of the streamFind R package and can also be installed from the GitHub repository.
```{r install-streamfinddata, eval=FALSE}
remotes::install_github("ricardobachertdacunha/streamFindData")
```
### Documentation
The documentation and usage examples of the streamFind R package can be found in the [reference page](https://ricardobachertdacunha.github.io/streamFind/reference/index.html) and [articles](https://ricardobachertdacunha.github.io/streamFind/articles/index.html) of the [webpage](https://ricardobachertdacunha.github.io/streamFind/index.html).
# References
---
nocite: '@*'
---