1
0
mirror of https://github.com/msberends/AMR.git synced 2025-07-08 11:11:54 +02:00

(v1.4.0.9033) documentation update

This commit is contained in:
2020-12-08 12:37:25 +01:00
parent 1bdb136b3a
commit 2145f1d1ba
110 changed files with 839 additions and 576 deletions

View File

@ -39,7 +39,7 @@
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">AMR (for R)</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">1.4.0.9030</span>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">1.4.0.9032</span>
</span>
</div>
@ -227,20 +227,20 @@
times <span class="op">=</span> <span class="fl">10</span><span class="op">)</span>
<span class="fu"><a href="https://docs.ropensci.org/skimr/reference/print.html">print</a></span><span class="op">(</span><span class="va">S.aureus</span>, unit <span class="op">=</span> <span class="st">"ms"</span>, signif <span class="op">=</span> <span class="fl">2</span><span class="op">)</span>
<span class="co"># Unit: milliseconds</span>
<span class="co"># expr min lq mean median uq max</span>
<span class="co"># as.mo("sau") 11.0 12 16.0 14.0 15.0 40.0</span>
<span class="co"># as.mo("stau") 110.0 120 140.0 140.0 150.0 160.0</span>
<span class="co"># as.mo("STAU") 110.0 120 140.0 140.0 140.0 150.0</span>
<span class="co"># as.mo("staaur") 12.0 13 20.0 15.0 16.0 45.0</span>
<span class="co"># as.mo("STAAUR") 15.0 15 26.0 16.0 41.0 58.0</span>
<span class="co"># as.mo("S. aureus") 31.0 35 50.0 59.0 62.0 65.0</span>
<span class="co"># as.mo("S aureus") 27.0 33 59.0 59.0 62.0 160.0</span>
<span class="co"># as.mo("Staphylococcus aureus") 1.9 2 2.4 2.4 2.7 2.9</span>
<span class="co"># as.mo("Staphylococcus aureus (MRSA)") 910.0 960 980.0 970.0 1000.0 1100.0</span>
<span class="co"># as.mo("Sthafilokkockus aaureuz") 400.0 410 430.0 420.0 440.0 560.0</span>
<span class="co"># as.mo("MRSA") 12.0 13 19.0 15.0 15.0 42.0</span>
<span class="co"># as.mo("VISA") 20.0 22 31.0 24.0 47.0 54.0</span>
<span class="co"># as.mo("VRSA") 22.0 23 35.0 24.0 52.0 56.0</span>
<span class="co"># expr min lq mean median uq max</span>
<span class="co"># as.mo("sau") 13.0 13.0 17.0 15.0 16.0 43.0</span>
<span class="co"># as.mo("stau") 120.0 120.0 140.0 150.0 150.0 160.0</span>
<span class="co"># as.mo("STAU") 120.0 150.0 150.0 150.0 160.0 160.0</span>
<span class="co"># as.mo("staaur") 13.0 13.0 17.0 14.0 16.0 44.0</span>
<span class="co"># as.mo("STAAUR") 13.0 14.0 19.0 16.0 16.0 48.0</span>
<span class="co"># as.mo("S. aureus") 34.0 58.0 61.0 63.0 68.0 86.0</span>
<span class="co"># as.mo("S aureus") 33.0 34.0 46.0 36.0 63.0 63.0</span>
<span class="co"># as.mo("Staphylococcus aureus") 2.3 2.5 2.5 2.5 2.6 2.7</span>
<span class="co"># as.mo("Staphylococcus aureus (MRSA)") 980.0 980.0 1000.0 1000.0 1000.0 1100.0</span>
<span class="co"># as.mo("Sthafilokkockus aaureuz") 430.0 430.0 440.0 440.0 440.0 460.0</span>
<span class="co"># as.mo("MRSA") 13.0 14.0 18.0 16.0 17.0 43.0</span>
<span class="co"># as.mo("VISA") 21.0 22.0 23.0 22.0 24.0 25.0</span>
<span class="co"># as.mo("VRSA") 22.0 23.0 35.0 27.0 52.0 55.0</span>
<span class="co"># neval</span>
<span class="co"># 10</span>
<span class="co"># 10</span>
@ -284,8 +284,8 @@
<span class="fu"><a href="https://docs.ropensci.org/skimr/reference/print.html">print</a></span><span class="op">(</span><span class="va">run_it</span>, unit <span class="op">=</span> <span class="st">"ms"</span>, signif <span class="op">=</span> <span class="fl">3</span><span class="op">)</span>
<span class="co"># Unit: milliseconds</span>
<span class="co"># expr min lq mean median uq max neval</span>
<span class="co"># mo_name(x) 165 176 223 202 274 318 10</span></pre></div>
<p>So getting official taxonomic names of 2,000,000 (!!) items consisting of 90 unique values only takes 0.202 seconds. You only lose time on your unique input values.</p>
<span class="co"># mo_name(x) 145 190 221 213 248 313 10</span></pre></div>
<p>So getting official taxonomic names of 2,000,000 (!!) items consisting of 90 unique values only takes 0.213 seconds. You only lose time on your unique input values.</p>
</div>
<div id="precalculated-results" class="section level3">
<h3 class="hasAnchor">
@ -299,10 +299,10 @@
<span class="fu"><a href="https://docs.ropensci.org/skimr/reference/print.html">print</a></span><span class="op">(</span><span class="va">run_it</span>, unit <span class="op">=</span> <span class="st">"ms"</span>, signif <span class="op">=</span> <span class="fl">3</span><span class="op">)</span>
<span class="co"># Unit: milliseconds</span>
<span class="co"># expr min lq mean median uq max neval</span>
<span class="co"># A 7.83 8.05 9.56 9.43 10.90 12.90 10</span>
<span class="co"># B 23.50 24.40 30.20 25.50 26.80 74.50 10</span>
<span class="co"># C 2.00 2.19 2.42 2.41 2.56 3.06 10</span></pre></div>
<p>So going from <code><a href="../reference/mo_property.html">mo_name("Staphylococcus aureus")</a></code> to <code>"Staphylococcus aureus"</code> takes 0.0024 seconds - it doesnt even start calculating <em>if the result would be the same as the expected resulting value</em>. That goes for all helper functions:</p>
<span class="co"># A 8.36 8.59 8.99 9.07 9.29 9.62 10</span>
<span class="co"># B 26.80 27.50 28.10 28.00 29.10 29.80 10</span>
<span class="co"># C 2.06 2.15 6.68 2.50 2.69 45.20 10</span></pre></div>
<p>So going from <code><a href="../reference/mo_property.html">mo_name("Staphylococcus aureus")</a></code> to <code>"Staphylococcus aureus"</code> takes 0.0025 seconds - it doesnt even start calculating <em>if the result would be the same as the expected resulting value</em>. That goes for all helper functions:</p>
<div class="sourceCode" id="cb5"><pre class="downlit">
<span class="va">run_it</span> <span class="op">&lt;-</span> <span class="fu">microbenchmark</span><span class="op">(</span>A <span class="op">=</span> <span class="fu"><a href="../reference/mo_property.html">mo_species</a></span><span class="op">(</span><span class="st">"aureus"</span><span class="op">)</span>,
B <span class="op">=</span> <span class="fu"><a href="../reference/mo_property.html">mo_genus</a></span><span class="op">(</span><span class="st">"Staphylococcus"</span><span class="op">)</span>,
@ -316,14 +316,14 @@
<span class="fu"><a href="https://docs.ropensci.org/skimr/reference/print.html">print</a></span><span class="op">(</span><span class="va">run_it</span>, unit <span class="op">=</span> <span class="st">"ms"</span>, signif <span class="op">=</span> <span class="fl">3</span><span class="op">)</span>
<span class="co"># Unit: milliseconds</span>
<span class="co"># expr min lq mean median uq max neval</span>
<span class="co"># A 1.69 1.75 1.90 1.86 2.00 2.25 10</span>
<span class="co"># B 1.69 1.72 1.86 1.79 1.87 2.43 10</span>
<span class="co"># C 1.67 1.75 1.89 1.81 1.93 2.67 10</span>
<span class="co"># D 1.64 1.73 1.87 1.87 1.94 2.23 10</span>
<span class="co"># E 1.65 1.75 1.90 1.83 1.92 2.35 10</span>
<span class="co"># F 1.70 1.75 1.87 1.85 1.93 2.20 10</span>
<span class="co"># G 1.73 1.83 1.93 1.93 2.01 2.25 10</span>
<span class="co"># H 1.65 1.73 1.85 1.77 2.06 2.11 10</span></pre></div>
<span class="co"># A 1.68 1.91 2.13 2.08 2.43 2.62 10</span>
<span class="co"># B 1.89 1.99 2.16 2.05 2.30 2.69 10</span>
<span class="co"># C 1.87 1.91 2.09 2.00 2.28 2.46 10</span>
<span class="co"># D 1.65 1.71 1.92 1.87 1.98 2.58 10</span>
<span class="co"># E 1.64 1.74 1.90 1.87 1.98 2.34 10</span>
<span class="co"># F 1.86 1.92 2.05 2.05 2.16 2.27 10</span>
<span class="co"># G 1.73 1.80 1.99 1.97 2.14 2.29 10</span>
<span class="co"># H 1.85 1.93 2.08 1.98 2.15 2.93 10</span></pre></div>
<p>Of course, when running <code><a href="../reference/mo_property.html">mo_phylum("Firmicutes")</a></code> the function has zero knowledge about the actual microorganism, namely <em>S. aureus</em>. But since the result would be <code>"Firmicutes"</code> anyway, there is no point in calculating the result. And because this package knows all phyla of all known bacteria (according to the Catalogue of Life), it can just return the initial value immediately.</p>
</div>
<div id="results-in-other-languages" class="section level3">
@ -351,13 +351,13 @@
<span class="fu"><a href="https://docs.ropensci.org/skimr/reference/print.html">print</a></span><span class="op">(</span><span class="va">run_it</span>, unit <span class="op">=</span> <span class="st">"ms"</span>, signif <span class="op">=</span> <span class="fl">4</span><span class="op">)</span>
<span class="co"># Unit: milliseconds</span>
<span class="co"># expr min lq mean median uq max neval</span>
<span class="co"># en 16.23 16.62 21.00 17.00 18.51 59.06 100</span>
<span class="co"># de 19.27 19.96 22.73 20.36 21.08 69.70 100</span>
<span class="co"># nl 31.40 32.54 38.76 33.16 35.34 82.43 100</span>
<span class="co"># es 19.36 19.75 23.61 20.26 20.88 67.39 100</span>
<span class="co"># it 19.24 19.64 21.23 20.00 20.72 62.92 100</span>
<span class="co"># fr 19.19 19.82 25.12 20.16 21.49 70.00 100</span>
<span class="co"># pt 19.18 19.64 22.44 20.23 21.47 60.56 100</span></pre></div>
<span class="co"># en 16.16 17.85 22.42 18.54 19.61 68.28 100</span>
<span class="co"># de 19.55 21.38 24.37 21.96 22.95 61.55 100</span>
<span class="co"># nl 31.64 35.08 40.58 36.34 37.88 79.00 100</span>
<span class="co"># es 18.03 21.46 25.61 22.09 23.30 64.97 100</span>
<span class="co"># it 17.82 21.01 23.29 21.80 22.82 58.47 100</span>
<span class="co"># fr 18.19 21.29 25.63 21.93 23.20 60.48 100</span>
<span class="co"># pt 17.76 21.07 24.81 21.83 23.39 65.00 100</span></pre></div>
<p>Currently supported are German, Dutch, Spanish, Italian, French and Portuguese.</p>
</div>
</div>