diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2023-11-12 21:59:34 +0100 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2023-11-12 21:59:34 +0100 |
| commit | 4079a2c496aa4e8c6dc2a93afedcbedbf7a852b5 (patch) | |
| tree | 8281ddd094c84d3bd0663fe2f060985f4a212e6b /docs/reference/TOXSWA_cwa.html | |
| parent | d66bd4aa0bf9c4d9b8793a4e308c9e80691b440f (diff) | |
Enable markdown and rebuild docs
Diffstat (limited to 'docs/reference/TOXSWA_cwa.html')
| -rw-r--r-- | docs/reference/TOXSWA_cwa.html | 32 |
1 files changed, 28 insertions, 4 deletions
diff --git a/docs/reference/TOXSWA_cwa.html b/docs/reference/TOXSWA_cwa.html index a5a9a49..8908748 100644 --- a/docs/reference/TOXSWA_cwa.html +++ b/docs/reference/TOXSWA_cwa.html @@ -157,7 +157,7 @@ for the requested moving window sizes in days.</p></dd> </div><p></p><hr><a id="method-TOXSWA_cwa-moving_windows"></a><div class="section"> <h3 id="method-moving-windows-">Method <code>moving_windows()</code><a class="anchor" aria-label="anchor" href="#method-moving-windows-"></a></h3> -<p>Add to the `windows` field described above.</p><div class="section"> +<p>Add to the <code>windows</code> field described above.</p><div class="section"> <h4 id="usage-1">Usage<a class="anchor" aria-label="anchor" href="#usage-1"></a></h4> <p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">TOXSWA_cwa</span><span class="op">$</span><span class="fu">moving_windows</span><span class="op">(</span><span class="va">windows</span>, total <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div><p></p></div> </div> @@ -179,7 +179,7 @@ suspended matter will be used.</p></dd> </div><p></p><hr><a id="method-TOXSWA_cwa-get_events"></a><div class="section"> <h3 id="method-get-events-">Method <code>get_events()</code><a class="anchor" aria-label="anchor" href="#method-get-events-"></a></h3> <p>Populate a datataframe with event information for the specified -threshold value. The resulting dataframe is stored in the `events` +threshold value. The resulting dataframe is stored in the <code>events</code> field of the object.</p><div class="section"> <h4 id="usage-2">Usage<a class="anchor" aria-label="anchor" href="#usage-2"></a></h4> <p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">TOXSWA_cwa</span><span class="op">$</span><span class="fu">get_events</span><span class="op">(</span><span class="va">thresholds</span>, total <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div><p></p></div> @@ -201,7 +201,7 @@ suspended matter will be used.</p></dd> </div><p></p><hr><a id="method-TOXSWA_cwa-print"></a><div class="section"> <h3 id="method-print-">Method <code><a href="https://rdrr.io/r/base/print.html" class="external-link">print()</a></code><a class="anchor" aria-label="anchor" href="#method-print-"></a></h3> -<p>Print a `TOXSWA_cwa` object</p><div class="section"> +<p>Print a <code>TOXSWA_cwa</code> object</p><div class="section"> <h4 id="usage-3">Usage<a class="anchor" aria-label="anchor" href="#usage-3"></a></h4> <p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">TOXSWA_cwa</span><span class="op">$</span><span class="fu">print</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div> </div> @@ -237,7 +237,31 @@ suspended matter will be used.</p></dd> <span class="r-in"><span><span class="va">H_sw_R1_stream</span><span class="op">$</span><span class="fu">moving_windows</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">7</span>, <span class="fl">21</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">H_sw_R1_stream</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> <TOXSWA_cwa> data from file 00003s_pa.cwa segment 20 </span> -<span class="r-err co"><span class="r-pr">#></span> <span class="error">Error in head(self$cwas):</span> could not find function "head"</span> +<span class="r-out co"><span class="r-pr">#></span> datetime t t_firstjan t_rel_to_max cwa_mug_per_L</span> +<span class="r-out co"><span class="r-pr">#></span> 20 1978-10-01 00:00:00 0.000 273.0000 -55.333 0</span> +<span class="r-out co"><span class="r-pr">#></span> 40 1978-10-01 01:00:00 0.042 273.0417 -55.291 0</span> +<span class="r-out co"><span class="r-pr">#></span> 60 1978-10-01 02:00:00 0.083 273.0833 -55.250 0</span> +<span class="r-out co"><span class="r-pr">#></span> 80 1978-10-01 03:00:00 0.125 273.1250 -55.208 0</span> +<span class="r-out co"><span class="r-pr">#></span> 100 1978-10-01 04:00:00 0.167 273.1667 -55.166 0</span> +<span class="r-out co"><span class="r-pr">#></span> 120 1978-10-01 05:00:00 0.208 273.2083 -55.125 0</span> +<span class="r-out co"><span class="r-pr">#></span> cwa_tot_mug_per_L</span> +<span class="r-out co"><span class="r-pr">#></span> 20 0</span> +<span class="r-out co"><span class="r-pr">#></span> 40 0</span> +<span class="r-out co"><span class="r-pr">#></span> 60 0</span> +<span class="r-out co"><span class="r-pr">#></span> 80 0</span> +<span class="r-out co"><span class="r-pr">#></span> 100 0</span> +<span class="r-out co"><span class="r-pr">#></span> 120 0</span> +<span class="r-out co"><span class="r-pr">#></span> Moving window analysis</span> +<span class="r-out co"><span class="r-pr">#></span> window max_TWAC max_AUC_h max_AUC_d</span> +<span class="r-out co"><span class="r-pr">#></span> 1 7 days 2.3926551 401.9660 16.74859</span> +<span class="r-out co"><span class="r-pr">#></span> 2 21 days 0.8369248 421.8101 17.57542</span> +<span class="r-out co"><span class="r-pr">#></span> Event statistics for threshold 2 </span> +<span class="r-out co"><span class="r-pr">#></span> t_start cwa_max duration pre_interval AUC_h AUC_d</span> +<span class="r-out co"><span class="r-pr">#></span> 1 44.375 4.167238 0.208 44.375 17.77202 0.740501</span> +<span class="r-out co"><span class="r-pr">#></span> 2 55.042 40.584010 0.583 10.459 398.21189 16.592162</span> +<span class="r-out co"><span class="r-pr">#></span> Event statistics for threshold 10 </span> +<span class="r-out co"><span class="r-pr">#></span> t_start cwa_max duration pre_interval AUC_h AUC_d</span> +<span class="r-out co"><span class="r-pr">#></span> 1 55.083 40.58401 0.459 55.083 379.433 15.80971</span> </code></pre></div> </div> </main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2> |