-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
346 lines (263 loc) · 15.7 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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
---
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 = "66.67%",
dpi = 300
)
library(magrittr)
library(PlotFTIR)
```
# PlotFTIR <img src='man/figures/PlotFTIR_logo.png' align="right" width="25%" min-width="120px"/>
([Français](#introduction-et-installation))
<!-- badges: start -->
[](https://github.com/NRCan/PlotFTIR/actions/workflows/R-CMD-check.yaml)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://coveralls.io/github/NRCan/PlotFTIR)
[](https://cran.r-project.org/package=PlotFTIR)
<!-- badges: end -->
## Introduction and Installation
The goal of `PlotFTIR` is to easily and quickly kick-start the production of journal-quality Fourier Transform Infra-Red (FTIR) spectral plots in R using ggplot2. The produced plots can be published directly or further modified by ggplot2 functions.
You can install the development version of `PlotFTIR` from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("NRCan/PlotFTIR")
library(PlotFTIR)
```
## Example Plots
This is a basic example which shows you how to plot a prepared set of FTIR spectra:
```{r basic_plot_en}
biodiesel_plot <- plot_ftir(biodiesel)
biodiesel_plot
```
You can also plot spectra in a stacked/offset manner instead of overlaid:
```{r stack_plot_en}
# Generate a plot
plot_ftir_stacked(biodiesel)
```
Note the default plot and legend titles are in english but can be automatically changed to french defaults by supplying the `lang = 'fr'` argument to plot creation functions.
Plots can be manipulated, for example, by zooming in on a range:
```{r biodiesel_zoom_en}
# Zoom to a specified range of 1850 to 1650 cm^-1
zoom_in_on_range(biodiesel_plot, c(1650, 1850))
```
Some FTIR plots have a compressed low-energy portion of the graph which you might wish to zoom in on. You can achieve this by the following:
```{r biodiesel_compress_en}
# compress the data with wavenumbers above 2000 (to the left of 2000 on the
# plot) by a factor of 5
compress_low_energy(biodiesel_plot, cutoff = 2000, compression_ratio = 5)
```
You can also add marker lines (with labels) at specific wavenumbers on the plots, controlling their line or text properties as needed. Similarly, a shaded band can be added to indicate a region.
```{r biodiesel_labelled_en}
biodiesel_marked <- add_wavenumber_marker(biodiesel_plot,
wavenumber = 1742,
text = "C=O Stretch",
label_aesthetics = list("color" = "red")
)
add_band(biodiesel_marked, c(2750,3050), "C-H Stretch")
```
If the need arises to rename samples listed in the legend, this is possible via `rename_plot_sample_ids()`. Samples must be listed in the rename vector with the format `"new name" = "old name"`.
```{r biodiesel_rename_en}
new_names <- c(
"0.0% Biodiesel" = "biodiesel_0",
"0.25% Biodiesel" = "biodiesel_0_25",
"0.50% Biodiesel" = "biodiesel_0_50",
"1.0% Biodiesel" = "biodiesel_1_0",
"2.5% Biodiesel" = "biodiesel_2_5",
"5.0% Biodiesel" = "biodiesel_5_0",
"7.5% Biodiesel" = "biodiesel_7_5",
"10.0% Biodiesel" = "biodiesel_10_0",
"Commercial B0.5" = "biodiesel_B0_5",
"Commercial B5" = "biodiesel_B5",
"Unknown Biodiesel" = "diesel_unknown"
)
rename_plot_sample_ids(biodiesel_plot, new_names)
```
A helper function for the renaming is provided (see the documentation for `get_plot_sample_ids()`).
Specific sample(s) can be highlighted (other samples greyed out) by calling `highlight_sample()`.
Finally, plot legends are customizable (for basic changes) through a helper function `move_plot_legend()`.
## Data Sets
The package contains two datasets to provide example spectra for plotting:
* `biodiesel` is a set of diesels with 0 to 10 % FAMEs (fatty acid methyl esters; biodiesel) content, plus two known and one unknown diesel spectra.
* `sample_spectra` is a set of random FTIR spectra which includes spectra of pure toluene, isopropanol, and heptanes, as well as white printer paper and a polystyrene film.
An example of the `biodiesel` data set is below:
```{r biodiesel_head_en}
head(biodiesel)
```
## Tidy Plot Production
Note that because most functions return a data type similar to what is provided, tidy-eval is possible (using the base R pipe `|>` or [`magrittr` pipe function](https://magrittr.tidyverse.org/reference/pipe) `%>%`).
```{r tidy_en, warning=FALSE}
library(magrittr)
new_ids <- c(
"Toluene" = "toluene", "C7 Alkane" = "heptanes", "IPA" = "isopropanol",
"White Paper" = "paper", "PS Film" = "polystyrene"
)
sample_spectra |>
absorbance_to_transmittance() |>
plot_ftir(plot_title = "Example FTIR Spectra") |>
zoom_in_on_range(zoom_range = c(3800, 800)) |>
compress_low_energy(compression_ratio = 4) |>
add_wavenumber_marker(
wavenumber = 1495,
text = "C-C Aromatic",
line_aesthetics = list("linetype" = "dashed"),
label_aesthetics = list("color" = "#7e0021")
) |>
add_wavenumber_marker(
wavenumber = 3340,
text = "O-H Alcohol",
line_aesthetics = list("linetype" = "dotted"),
label_aesthetics = list("color" = "#ff420e")
) |>
rename_plot_sample_ids(sample_ids = new_ids) |>
move_plot_legend(position = "bottom", direction = "horizontal")
```
## Data Manipulation
FTIR spectral data can be converted between absorbance and transmittance. Only one type of data can exist in a data.frame and be plotted. The functions `absorbance_to_transmittance()` and `transmittance_to_absorbance()` perform these conversions.
```{r convert_datatype_en}
biodiesel_transm <- absorbance_to_transmittance(biodiesel)
head(biodiesel_transm)
```
Functions are provided for adjusting the baseline of spectra, adding or subtracting scalar values from entire spectra, normalizing spectra, and averaging spectra, see:
* `recalculate_baseline()`
* `add_scalar_value()` and `subtract_scalar_value()`
* `normalize_spectra()`
* `average_spectra()`
## Reading Files
`PlotFTIR` can read .csv and .asp file types. The .csv file should contain only one spectra, with columns for `wavenumber` and `absorbance` or `transmittance.` The .asp files should be according to the file specifications (not modified by the user).
## Interfacing With `ir` and `ChemoSpec` Packages
`PlotFTIR` has functions to interface with the `ir` package by Henning Teickner. This package offers complex baseline capabilities, smoothing, and more data analysis tools. More information on the `ir` package is available in their [documetation (via CRAN)](https://cran.r-project.org/package=ir). There is also capabilities to interface with `ChemoSpec` package by Bryan Hanson, which supports advanced statistics and chemometrics of spectral data. More information at [the `ChemoSpec` documentation](https://bryanhanson.github.io/ChemoSpec/index.html).
## Citing This Package
Please cite this package in any journal articles containing images produced by way of the package. If installed from GitHub or CRAN the date field will be properly filled with the publishing year.
```{r cite-en, warning=FALSE}
citation("PlotFTIR")
```
## Language Settings
The package has the ability to change language from English to French for plots on a per-plot basis (call `plot_ftir()` functions with `lang = 'en'` or `lang = 'fr` arguments). In addition, the default language can be set to English or French by setting `options('PlotFTIR.lang' = 'en')` or `options('PlotFTIR.lang' = 'fr')` respectively. This can be added to your .RProfile to persist between R sessions.
([English](#introduction-and-installation))
## Introduction et installation
Le but de `PlotFTIR` est de lancer facilement et rapidement la production des tracés de spectres de spectroscopie infrarouge à transformée de Fourier (IRTF) de qualité de revues scientifiques dans le system R en utilisant ggplot2. Les tracés produits peuvent être publiés directement ou modifiés par les fonctions ggplot2.
Vous pouvez installer la version de développement de `PlotFTIR` depuis [GitHub](https://github.com/) avec:
``` r
# install.packages("devtools")
devtools::install_github("NRCan/PlotFTIR")
library(PlotFTIR)
```
## Exemples des tracés
Ceci est un example de base qui vous montre comment tracer un ensemble de spectres IRTF dejà preparé:
```{r basic_plot_fr}
library(PlotFTIR)
plot_ftir(sample_spectra, lang = "fr")
```
Vous pouvez également tracer les spectres de manière empilée/décalée au lieu de les superposer :
```{r stack_plot_fr}
plot_ftir_stacked(biodiesel, plot_title = "Spectre IRTF empilée", lang = "fr")
```
Notez que les titres par défaut de tracé et du légende sont en anglais, mais qu'ils peuvent être automatiquement modifiés en français en fournissant l'argument `lang = 'fr'` aux fonctions de création de tracés.
Les tracés peuvent être manipulés, par exemple, en zoomant sur une plage :
```{r biodiesel_zoom_fr}
# Générer un tracé
biodiesel_trace <- plot_ftir(biodiesel, lang = "fr")
# Zoom sur une plage spécifiée de 1850 à 1650 cm^-1
zoom_in_on_range(biodiesel_trace, c(1650, 1850))
```
Certains tracés IRTF ont une partie compressée du graphique à faible énergie qui peuvent etre agrandie de la manière suivante :
```{r biodiesel_compress_fr}
# compresser les données avec des nombres d'onde supérieurs à 2000 (à gauche de
# 2000 sur le tracé) d'un facteur 5
compress_low_energy(biodiesel_trace, cutoff = 2000, compression_ratio = 5)
```
Vous pouvez également ajouter des lignes de marqueur (avec des étiquettes) à des numéros d'onde spécifiques sur les tracés, en contrôlant leurs propriétés de ligne ou de texte selon vos besoins. De même, une bande ombrée peut être ajoutée pour indiquer une région.
```{r biodiesel_labelled_fr}
biodiesel_marked <- add_wavenumber_marker(biodiesel_trace,
wavenumber = 1742,
text = "C=O étirement",
label_aesthetics = list("color" = "red")
)
add_band(biodiesel_marked, c(2750,3050), "C-H étirement")
```
S'il est nécessaire de renommer les échantillons répertoriés dans la légende, cela est possible via `rename_plot_sample_ids()`. Le vecteur de renommage doit avoir le format `"nouveau nom" = "ancien nom"`.
```{r biodiesel_rename_fr}
nouveau_noms <- c(
"0,0% Biodiesel" = "biodiesel_0",
"0,25% Biodiesel" = "biodiesel_0_25",
"0,50% Biodiesel" = "biodiesel_0_50",
"1,0% Biodiesel" = "biodiesel_1_0",
"2,5% Biodiesel" = "biodiesel_2_5",
"5,0% Biodiesel" = "biodiesel_5_0",
"7,5% Biodiesel" = "biodiesel_7_5",
"10,0% Biodiesel" = "biodiesel_10_0",
"B0,5 Commercial" = "biodiesel_B0_5",
"B5 Commercial" = "biodiesel_B5",
"Biodiesel Inconnu" = "diesel_unknown"
)
rename_plot_sample_ids(biodiesel_trace, nouveau_noms)
```
Une fonction d'assistance pour le changement de nom est fournie (voir la documentation pour `get_plot_sample_ids()`).
Un ou plusieurs échantillons spécifiques peuvent être mis en évidence (les autres échantillons étant grisés) en appelant `highlight_sample()`.
Enfin, les légendes des tracés sont personnalisables (pour les modifications de base) via une fonction d'assistance `move_plot_legend()`.
## Production de tracés "tidy"
Notez que comme la plupart des fonctions renvoient un type de données similaire à celui qui est fourni, l'évaluation des données est possible (en utilisant [la fonction `magrittr` tuyau](https://magrittr.tidyverse.org/reference/pipe) `%>%`).
```{r tidy_fr, warning=FALSE}
library(magrittr)
nouveaux_ids <- c(
"Toluène" = "toluene", "C7 alcane" = "heptanes", "alcool isopropylique" = "isopropanol",
"papier blanc" = "paper", "film de polystyrène" = "polystyrene"
)
sample_spectra |>
absorbance_to_transmittance() |>
plot_ftir(plot_title = "Exemple de spectres IRTF", lang = "fr") |>
zoom_in_on_range(zoom_range = c(3800, 800)) |>
compress_low_energy(compression_ratio = 4) |>
add_wavenumber_marker(
wavenumber = 1495,
text = "C-C aromatique",
line_aesthetics = list("linetype" = "dashed"),
label_aesthetics = list("color" = "#7e0021")
) |>
add_wavenumber_marker(
wavenumber = 3340,
text = "O-H alcool",
line_aesthetics = list("linetype" = "dotted"),
label_aesthetics = list("color" = "#ff420e")
) |>
rename_plot_sample_ids(sample_ids = nouveaux_ids) |>
move_plot_legend(position = "bottom", direction = "horizontal")
```
## Production de tracés "tidy"
Notez que, comme la plupart des fonctions renvoient un type de données similaire à celui fourni, une "tidy-eval" est possible.
## Ensembles des données
Le package contient deux ensembles de données pour fournir des exemples de spectres à tracer:
* `biodiesel` est un ensemble de diesels avec une teneur en esters méthyliques d'acides gras (EMAGs) (ou biodiesel) de 0 à 10 %, plus deux spectres de diesel connus et un inconnu.
* `sample_spectra` est un ensemble de spectres IRTF aléatoires qui comprennent des spectres de toluène pur, d'isopropanol et d'heptanes, ainsi que du papier d'imprimante blanc et un film de polystyrène.
Un exemple de l'ensemble de données `biodiesel` est ci-dessous:
```{r biodiesel_head_fr}
head(biodiesel)
```
## Manipulation de données
Les données spectrales IRTF peuvent être converties entre l'absorbance et la transmission. Un seul type de données peut exister dans un data.frame et être tracé. Les fonctions `absorbance_to_transmittance()` et `transmittance_to_absorbance()` effectuent ces conversions.
```{r convert_datatype_fr}
biodiesel_transm <- absorbance_to_transmittance(biodiesel)
head(biodiesel_transm)
```
Des fonctions sont fournies pour ajuster la ligne de base des spectres, ajouter ou soustraire des valeurs scalaires de spectres entiers, normalisation des spectres, et calculer la moyenne des spectres, voir :
* `recalculate_baseline()`
* `add_scalar_value()` et `subtract_scalar_value()`
* `normalize_spectra()`
* `average_spectra()`
## Lecture des fichiers
`PlotFTIR` peut lire les fichiers de type .csv et .asp. Le fichier .csv ne doit contenir qu'un seul spectre, avec des colonnes pour le `wavenumber` et `absorbance` ou `transmittance`. Les fichiers .asp doivent être conformes aux spécifications du fichier (non modifiées par l'utilisateur).
## Interfaçage avec le paquetage `ir`
`PlotFTIR` possède des fonctions pour s'interfacer avec le paquet `ir` de Teickner. Ce package offre des capacités de lignes de base complexes, de lissage, et plus d'outils d'analyse de données. Plus d'informations sur le paquet `ir` sont disponibles dans leur [documetation (via CRAN)] (https://cran.r-project.org/package=ir). Il est également possible de s'interfacer avec le paquet `ChemoSpec` de Bryan Hanson, qui prend en charge les statistiques avancées et la chimiométrie des données spectrales. Plus d'informations sur [la documentation de `ChemoSpec`] (https://bryanhanson.github.io/ChemoSpec/index.html).
## Citer ce paquet
Veuillez citer ce paquet dans tout article de journal contenant des images produites à l'aide de ce paquet. Si le paquet est installé à partir de GitHub ou de CRAN, le texte de la date sera correctement rempli avec l'année de publication.
```{r cite-fr, warning=FALSE}
citation("PlotFTIR")
```
## Paramètres de langue
Le paquetage a la capacité de changer la langue de l'anglais au français pour les tracés sur une base individuelle (appeler les fonctions `plot_ftir()` avec les arguments `lang = 'en'` ou `lang = 'fr'`). De plus, la langue par défaut peut être réglée sur l'anglais ou le français en réglant `options('PlotFTIR.lang' = 'en')` ou `options('PlotFTIR.lang' = 'fr')` respectivement. Ceci peut être ajouté à votre .RProfile pour persister entre les sessions R.