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.
168 lines
9.2 KiB
168 lines
9.2 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>Plot tibble spectra — plot_spc • 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="Plot tibble spectra — plot_spc"><meta property="og:description" content="Plot spectra from tibble spectra objects."><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-topic">
|
|
<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="col-md-9 contents">
|
|
<div class="page-header">
|
|
<h1>Plot tibble spectra</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/philipp-baumann/simplerspec/blob/HEAD/R/plot_spc.R" class="external-link"><code>R/plot_spc.R</code></a></small>
|
|
<div class="hidden name"><code>plot_spc.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
<p>Plot spectra from tibble spectra objects.</p>
|
|
</div>
|
|
|
|
<div id="ref-usage">
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">plot_spc</span><span class="op">(</span><span class="va">spc_tbl</span>, spc_tbl_2 <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> x_unit <span class="op">=</span> <span class="st">"wavenumber"</span>,</span>
|
|
<span> y <span class="op">=</span> <span class="st">"spc"</span>, by <span class="op">=</span> <span class="st">"unique_id"</span>,</span>
|
|
<span> graph_id_1 <span class="op">=</span> <span class="st">"Set 1"</span>, graph_id_2 <span class="op">=</span> <span class="st">"Set 2"</span>,</span>
|
|
<span> graph_id_1_col <span class="op">=</span> <span class="st">"black"</span>, graph_id_2_col <span class="op">=</span> <span class="st">"red"</span>,</span>
|
|
<span> xlab <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/expression.html" class="external-link">expression</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/paste.html" class="external-link">paste</a></span><span class="op">(</span><span class="st">"Wavenumber ["</span>, <span class="va">cm</span><span class="op">^</span><span class="op">-</span><span class="fl">1</span>, <span class="st">"]"</span><span class="op">)</span><span class="op">)</span>,</span>
|
|
<span> ylab <span class="op">=</span> <span class="st">"Absorbance"</span>,</span>
|
|
<span> alpha <span class="op">=</span> <span class="fl">0.2</span>, legend <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></code></pre></div>
|
|
</div>
|
|
|
|
<div id="arguments">
|
|
<h2>Arguments</h2>
|
|
<dl><dt>spc_tbl</dt>
|
|
<dd><p>Tibble that contains the first set of spectra to plot as
|
|
list-column</p></dd>
|
|
|
|
|
|
<dt>spc_tbl_2</dt>
|
|
<dd><p>Tibble that contains the second set of spectra (optional)
|
|
to plot as list-column.</p></dd>
|
|
|
|
|
|
<dt>x_unit</dt>
|
|
<dd><p>Character string describing the x axis unit. Default is
|
|
<code>"wavenumber"</code>, which will produce a graph with wavenumbers on the
|
|
x axis with reversed number. If <code>x_unit = "wavelength"</code>, the axis
|
|
will be in regular order (lower wavelengths in nm on the left and higher
|
|
on the right side of the axis).</p></dd>
|
|
|
|
|
|
<dt>y</dt>
|
|
<dd><p>Character string of list-column name in tibble where spectra of
|
|
desired type are extracted to plot.</p></dd>
|
|
|
|
|
|
<dt>by</dt>
|
|
<dd><p>Character string of column that is used to group the spectra.
|
|
Default is <code>"unique_id"</code>. 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"</code> as argument to group according
|
|
the sample_id column in the tibble(s) containing the spectra (<code>spc_tbl</code>
|
|
and <code>spc_tbl_2</code>).</p></dd>
|
|
|
|
|
|
<dt>graph_id_1</dt>
|
|
<dd><p>Character string used for grouping the first spectra set
|
|
(<code>spc_tbl</code>) and producing
|
|
the label text accordingly. Default is <code>"Set 1"</code>.</p></dd>
|
|
|
|
|
|
<dt>graph_id_2</dt>
|
|
<dd><p>Character string used for grouping the second spectra set
|
|
(<code>spc_tbl_2</code>) and producing the label text accordingly. Default is
|
|
<code>"Set 2"</code></p></dd>
|
|
|
|
|
|
<dt>graph_id_1_col</dt>
|
|
<dd><p>Character string for the colour of the first spectra
|
|
set. Default is <code>"black"</code>.</p></dd>
|
|
|
|
|
|
<dt>graph_id_2_col</dt>
|
|
<dd><p>Character string for the colour of the first spectra
|
|
set. Default is <code>"red"</code>.</p></dd>
|
|
|
|
|
|
<dt>xlab</dt>
|
|
<dd><p>Character string or mathematical expression
|
|
(use <code>expression</code>) for the x axis title. Default is
|
|
<code>expression(paste("Wavenumber [", cm^-1, "]"))</code>.</p></dd>
|
|
|
|
|
|
<dt>ylab</dt>
|
|
<dd><p>Character string or mathematical expression
|
|
(use <code>expression</code>) for the y axis title. Default is <code>"absorbance"</code>.</p></dd>
|
|
|
|
|
|
<dt>alpha</dt>
|
|
<dd><p>Double in between 0 and 1. Sets the transparency for the plotted
|
|
spectra lines.</p></dd>
|
|
|
|
|
|
<dt>legend</dt>
|
|
<dd><p>Logical whether to plot a legend for the spectra describing
|
|
its name selected in arguments <code>graph_id_1</code> and <code>graph_id_2</code>.
|
|
Default is <code>TRUE</code>.</p></dd>
|
|
|
|
</dl></div>
|
|
|
|
</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>
|
|
|
|
|