Streamlining spectral data processing and modeling for spectroscopy applications
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.

206 lines
11 KiB

<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Function reference • simplerspec</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Function reference"><meta name="robots" content="noindex"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
<div class="container template-reference-index">
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">simplerspec</a>
<span class="version label label-danger" data-toggle="tooltip" data-placement="bottom" title="In-development version">0.1.0.9001</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav"><li>
<a href="../reference/index.html">Reference</a>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul><ul class="nav navbar-nav navbar-right"><li>
<a href="https://github.com/philipp-baumann/simplerspec/" class="external-link">
<span class="fab fa-github fa-lg"></span>
</a>
</li>
</ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header><div class="row">
<div class="contents col-md-9">
<div class="page-header">
<h1>Reference</h1>
</div>
<table class="ref-index"><colgroup><col class="alias"><col class="title"></colgroup><tbody><tr><th colspan="2">
<h2 id="all-functions">All functions <a href="#all-functions" class="anchor" aria-hidden="true"></a></h2>
<p class="section-desc"></p>
</th>
</tr></tbody><tbody><tr><td>
<p><code><a href="assess_multimodels.html">assess_multimodels()</a></code> </p>
</td>
<td><p>Assess multiple pairs of measured and predicted values</p></td>
</tr><tr><td>
<p><code><a href="average_spc.html">average_spc()</a></code> </p>
</td>
<td><p>Average spectra in list-column by entries in grouping column</p></td>
</tr><tr><td>
<p><code><a href="bind_lcols_dts.html">bind_lcols_dts()</a></code> </p>
</td>
<td><p>Bind list-columns within a tibble into a list of data.tables</p></td>
</tr><tr><td>
<p><code><a href="create_vip_rects.html">create_vip_rects()</a></code> </p>
</td>
<td><p>Create a data frame containing start and end positions (wavenumbers)
where variable importance in projection (VIP) is &gt; 1</p></td>
</tr><tr><td>
<p><code><a href="evaluate_model.html">evaluate_model()</a></code> <code><a href="evaluate_model.html">summary_df()</a></code> </p>
</td>
<td><p>Calculate model evaluation metrics</p></td>
</tr><tr><td>
<p><code><a href="extract_lcols2dts.html">extract_lcols2dts()</a></code> </p>
</td>
<td><p>Extract multiple tibble list-columns and return data as list of
data.tables</p></td>
</tr><tr><td>
<p><code><a href="extract_pls_vip.html">extract_pls_vip()</a></code> </p>
</td>
<td><p>Extract VIPs (variable importance in the projection) for a PLS
regression model output returned from model fitting with
<code><a href="../reference/fit_pls.html">simplerspec::fit_pls()</a></code></p></td>
</tr><tr><td>
<p><code><a href="fit_pls.html">fit_pls()</a></code> <code><a href="fit_pls.html">pls_ken_stone()</a></code> </p>
</td>
<td><p>Calibration sampling, model tuning, and PLS regression</p></td>
</tr><tr><td>
<p><code><a href="fit_rf.html">fit_rf()</a></code> </p>
</td>
<td><p>Calibration sampling, and random forest model tuning and evaluation</p></td>
</tr><tr><td>
<p><code><a href="gather_spc.html">gather_spc()</a></code> </p>
</td>
<td><p>Gather measurements of different spectra types, corresponding
x-axis values and metadata from nested list.</p></td>
</tr><tr><td>
<p><code><a href="join_chem_spec.html">join_chem_spec()</a></code> </p>
</td>
<td><p>Join chemical and spectral data frames</p></td>
</tr><tr><td>
<p><code><a href="join_spc_chem.html">join_spc_chem()</a></code> </p>
</td>
<td><p>Join spectra data and chemical data tibbles</p></td>
</tr><tr><td>
<p><code><a href="merge_dts.html">merge_dts()</a></code> </p>
</td>
<td><p>Merge list-columns of spectra, x-axis values, metadata and additional
measured variables into a single long form data.table</p></td>
</tr><tr><td>
<p><code><a href="merge_dts_l.html">merge_dts_l()</a></code> </p>
</td>
<td><p>Wrapper function around <code><a href="../reference/merge_dts.html">merge_dts()</a></code> for list of tibbles to
aggregate data for plotting.</p></td>
</tr><tr><td>
<p><code><a href="plot_pls_vip.html">plot_pls_vip()</a></code> </p>
</td>
<td><p>Plot stacked ggplot2 graphs with the Variable Importance for the
Projection (VIP) scores, mean replicate spectra (absorbance) per sample_id,
and the preprocessed spectra.</p></td>
</tr><tr><td>
<p><code><a href="plot_spc.html">plot_spc()</a></code> </p>
</td>
<td><p>Plot tibble spectra</p></td>
</tr><tr><td>
<p><code><a href="plot_spc_ext.html">plot_spc_ext()</a></code> </p>
</td>
<td><p>ggplot2 wrapper for extended spectra plotting</p></td>
</tr><tr><td>
<p><code><a href="predict_from_spc.html">predict_from_spc()</a></code> </p>
</td>
<td><p>Predict soil properties of new spectra based on a list of calibration models</p></td>
</tr><tr><td>
<p><code><a href="preprocess_spc.html">preprocess_spc()</a></code> </p>
</td>
<td><p>Preprocess spectra</p></td>
</tr><tr><td>
<p><code><a href="read_asd.html">read_asd()</a></code> </p>
</td>
<td><p>Read ASD fieldspec spectrometer data export into into simplerspec
spectra tibble.</p></td>
</tr><tr><td>
<p><code><a href="read_asd_bin.html">read_asd_bin()</a></code> </p>
</td>
<td><p>Read ASD binary files and gather spectra and metadata in tibble data
frame.</p></td>
</tr><tr><td>
<p><code><a href="read_opus_bin_univ.html">read_opus_bin_univ()</a></code> </p>
</td>
<td><p>Read a Bruker OPUS spectrum binary file</p></td>
</tr><tr><td>
<p><code><a href="read_opus_univ.html">read_opus_univ()</a></code> </p>
</td>
<td><p>Read a list of Bruker OPUS spectrum binary files.</p></td>
</tr><tr><td>
<p><code><a href="remove_outliers.html">remove_outliers()</a></code> </p>
</td>
<td><p>Remove outlier spectra</p></td>
</tr><tr><td>
<p><code><a href="resample_spc.html">resample_spc()</a></code> </p>
</td>
<td><p>Resample spectra in list-column to new x-axis interval</p></td>
</tr><tr><td>
<p><code><a href="select_ref_spc.html">select_ref_spc()</a></code> </p>
</td>
<td><p>Select a set of reference spectra to be measured by reference analysis
methods</p></td>
</tr><tr><td>
<p><code><a href="select_spc_vars.html">select_spc_vars()</a></code> </p>
</td>
<td><p>Select every n-th spectral variable for all spectra and x-values in spectral
tibble (<code>spc_tbl</code>)</p></td>
</tr><tr><td>
<p><code><a href="slice_xvalues.html">slice_xvalues()</a></code> </p>
</td>
<td><p>Slice spectra into defined x-axis ranges</p></td>
</tr><tr><td>
<p><code><a href="split_df2l.html">split_df2l()</a></code> </p>
</td>
<td><p>Split a tibble data frame into a list of tibbles by a group column</p></td>
</tr></tbody></table></div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
</nav></div>
</div>
<footer><div class="copyright">
<p></p><p>Developed by Philipp Baumann.</p>
</div>
<div class="pkgdown">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
</div>
</footer></div>
</body></html>