-
Notifications
You must be signed in to change notification settings - Fork 10
/
README.Rmd
59 lines (39 loc) · 2.16 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
---
output:
github_document:
html_preview: true
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
fig.path = "inst/images/README-"
)
```
## eemR
<!-- badges: start -->
[](http://www.gnu.org/licenses/gpl-2.0.html) [](https://cran.r-project.org/package=eemR) [](https://www.r-pkg.org:443/pkg/eemR) [](https://doi.org/10.5281/zenodo.3257526)
[](https://app.codecov.io/gh/PMassicotte/eemR?branch=main)
[](https://github.com/PMassicotte/eemR/actions)
<!-- badges: end -->
The **eemR** package implements various functions used calculate metrics from excitation-emission matrix (EEM) as well as to preform pre-processing corrections before PARAFAC analysis.
The latest release of the package from CRAN can be installed with:
```{r, eval = FALSE}
install.packages("eemR")
```
The latest development version of the package can be installed with:
```{r install, eval = FALSE}
devtools::install_github("PMassicotte/eemR")
```
## Vignette
A detailed vignette presenting the package which can be viewed using:
```{r, eval = FALSE}
vignette(topic = "introduction", package = "eemR")
```
## Supported spectrophotometers
At the moment, EEMs generated by the following spectrofluorometer are officially supported.
- Cary Eclipse `.csv` files
- Aqualog `.dat` files
- Shimadzu `.TXT` files
- Fluoromax-4 `.dat` files
- Hitachi F-7000 FL `.TXT` files
EEM can be read using the `eem_read()` function. Please fill an [issue](https://github.com/PMassicotte/eemR/issues) if you have other file formats you would like to add to the package. You can also write your own [import function](http://pmassicotte.github.io/eemR/articles/custom-import-function.html)!