You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
69 lines
2.6 KiB
69 lines
2.6 KiB
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/plot_spc.R
|
|
\name{plot_spc}
|
|
\alias{plot_spc}
|
|
\title{Plot tibble spectra}
|
|
\usage{
|
|
plot_spc(spc_tbl, spc_tbl_2 = NULL,
|
|
x_unit = "wavenumber",
|
|
y = "spc", by = "unique_id",
|
|
graph_id_1 = "Set 1", graph_id_2 = "Set 2",
|
|
graph_id_1_col = "black", graph_id_2_col = "red",
|
|
xlab = expression(paste("Wavenumber [", cm^-1, "]")),
|
|
ylab = "Absorbance",
|
|
alpha = 0.2, legend = TRUE)
|
|
}
|
|
\arguments{
|
|
\item{spc_tbl}{Tibble that contains the first set of spectra to plot as
|
|
list-column}
|
|
|
|
\item{spc_tbl_2}{Tibble that contains the second set of spectra (optional)
|
|
to plot as list-column.}
|
|
|
|
\item{x_unit}{Character string describing the x axis unit. Default is
|
|
\code{"wavenumber"}, which will produce a graph with wavenumbers on the
|
|
x axis with reversed number. If \code{x_unit = "wavelength"}, the axis
|
|
will be in regular order (lower wavelengths in nm on the left and higher
|
|
on the right side of the axis).}
|
|
|
|
\item{y}{Character string of list-column name in tibble where spectra of
|
|
desired type are extracted to plot.}
|
|
|
|
\item{by}{Character string of column that is used to group the spectra.
|
|
Default is \code{"unique_id"}. If replica spectra are present in the file
|
|
and processed spectra resulting after averaging need to be plotted,
|
|
it is recommend to use \code{"sample_id"} as argument to group according
|
|
the sample_id column in the tibble(s) containing the spectra (\code{spc_tbl}
|
|
and \code{spc_tbl_2}).}
|
|
|
|
\item{graph_id_1}{Character string used for grouping the first spectra set
|
|
(\code{spc_tbl}) and producing
|
|
the label text accordingly. Default is \code{"Set 1"}.}
|
|
|
|
\item{graph_id_2}{Character string used for grouping the second spectra set
|
|
(\code{spc_tbl_2}) and producing the label text accordingly. Default is
|
|
\code{"Set 2"}}
|
|
|
|
\item{graph_id_1_col}{Character string for the colour of the first spectra
|
|
set. Default is \code{"black"}.}
|
|
|
|
\item{graph_id_2_col}{Character string for the colour of the first spectra
|
|
set. Default is \code{"red"}.}
|
|
|
|
\item{xlab}{Character string or mathematical expression
|
|
(use \code{expression}) for the x axis title. Default is
|
|
\code{expression(paste("Wavenumber [", cm^-1, "]"))}.}
|
|
|
|
\item{ylab}{Character string or mathematical expression
|
|
(use \code{expression}) for the y axis title. Default is \code{"absorbance"}.}
|
|
|
|
\item{alpha}{Double in between 0 and 1. Sets the transparency for the plotted
|
|
spectra lines.}
|
|
|
|
\item{legend}{Logical whether to plot a legend for the spectra describing
|
|
its name selected in arguments \code{graph_id_1} and \code{graph_id_2}.
|
|
Default is \code{TRUE}.}
|
|
}
|
|
\description{
|
|
Plot spectra from tibble spectra objects.
|
|
}
|
|
|