mirror of
https://github.com/msberends/AMR.git
synced 2025-07-15 18:43:12 +02:00
(v1.4.0.9000) more extensive unit tests
This commit is contained in:
@ -82,7 +82,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</span>
|
||||
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">1.4.0.9000</span>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
@ -242,39 +242,39 @@
|
||||
<p>These function can be used to determine first isolates (see <code><a href='first_isolate.html'>first_isolate()</a></code>). Using key antibiotics to determine first isolates is more reliable than without key antibiotics. These selected isolates will then be called first <em>weighted</em> isolates.</p>
|
||||
</div>
|
||||
|
||||
<pre class="usage"><span class='fu'>key_antibiotics</span>(
|
||||
<span class='kw'>x</span>,
|
||||
col_mo = <span class='kw'>NULL</span>,
|
||||
universal_1 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"amoxicillin"</span>),
|
||||
universal_2 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"amoxicillin/clavulanic acid"</span>),
|
||||
universal_3 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"cefuroxime"</span>),
|
||||
universal_4 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"piperacillin/tazobactam"</span>),
|
||||
universal_5 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"ciprofloxacin"</span>),
|
||||
universal_6 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"trimethoprim/sulfamethoxazole"</span>),
|
||||
GramPos_1 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"vancomycin"</span>),
|
||||
GramPos_2 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"teicoplanin"</span>),
|
||||
GramPos_3 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"tetracycline"</span>),
|
||||
GramPos_4 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"erythromycin"</span>),
|
||||
GramPos_5 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"oxacillin"</span>),
|
||||
GramPos_6 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"rifampin"</span>),
|
||||
GramNeg_1 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"gentamicin"</span>),
|
||||
GramNeg_2 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"tobramycin"</span>),
|
||||
GramNeg_3 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"colistin"</span>),
|
||||
GramNeg_4 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"cefotaxime"</span>),
|
||||
GramNeg_5 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"ceftazidime"</span>),
|
||||
GramNeg_6 = <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span>(<span class='kw'>x</span>, <span class='st'>"meropenem"</span>),
|
||||
warnings = <span class='fl'>TRUE</span>,
|
||||
<span class='kw'>...</span>
|
||||
)
|
||||
<pre class="usage"><span class='fu'>key_antibiotics</span><span class='op'>(</span>
|
||||
<span class='va'>x</span>,
|
||||
col_mo <span class='op'>=</span> <span class='cn'>NULL</span>,
|
||||
universal_1 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"amoxicillin"</span><span class='op'>)</span>,
|
||||
universal_2 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"amoxicillin/clavulanic acid"</span><span class='op'>)</span>,
|
||||
universal_3 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"cefuroxime"</span><span class='op'>)</span>,
|
||||
universal_4 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"piperacillin/tazobactam"</span><span class='op'>)</span>,
|
||||
universal_5 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"ciprofloxacin"</span><span class='op'>)</span>,
|
||||
universal_6 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"trimethoprim/sulfamethoxazole"</span><span class='op'>)</span>,
|
||||
GramPos_1 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"vancomycin"</span><span class='op'>)</span>,
|
||||
GramPos_2 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"teicoplanin"</span><span class='op'>)</span>,
|
||||
GramPos_3 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"tetracycline"</span><span class='op'>)</span>,
|
||||
GramPos_4 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"erythromycin"</span><span class='op'>)</span>,
|
||||
GramPos_5 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"oxacillin"</span><span class='op'>)</span>,
|
||||
GramPos_6 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"rifampin"</span><span class='op'>)</span>,
|
||||
GramNeg_1 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"gentamicin"</span><span class='op'>)</span>,
|
||||
GramNeg_2 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"tobramycin"</span><span class='op'>)</span>,
|
||||
GramNeg_3 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"colistin"</span><span class='op'>)</span>,
|
||||
GramNeg_4 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"cefotaxime"</span><span class='op'>)</span>,
|
||||
GramNeg_5 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"ceftazidime"</span><span class='op'>)</span>,
|
||||
GramNeg_6 <span class='op'>=</span> <span class='fu'><a href='guess_ab_col.html'>guess_ab_col</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='st'>"meropenem"</span><span class='op'>)</span>,
|
||||
warnings <span class='op'>=</span> <span class='cn'>TRUE</span>,
|
||||
<span class='va'>...</span>
|
||||
<span class='op'>)</span>
|
||||
|
||||
<span class='fu'>key_antibiotics_equal</span>(
|
||||
<span class='kw'>y</span>,
|
||||
<span class='kw'>z</span>,
|
||||
type = <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"keyantibiotics"</span>, <span class='st'>"points"</span>),
|
||||
ignore_I = <span class='fl'>TRUE</span>,
|
||||
points_threshold = <span class='fl'>2</span>,
|
||||
info = <span class='fl'>FALSE</span>
|
||||
)</pre>
|
||||
<span class='fu'>key_antibiotics_equal</span><span class='op'>(</span>
|
||||
<span class='va'>y</span>,
|
||||
<span class='va'>z</span>,
|
||||
type <span class='op'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span><span class='op'>(</span><span class='st'>"keyantibiotics"</span>, <span class='st'>"points"</span><span class='op'>)</span>,
|
||||
ignore_I <span class='op'>=</span> <span class='cn'>TRUE</span>,
|
||||
points_threshold <span class='op'>=</span> <span class='fl'>2</span>,
|
||||
info <span class='op'>=</span> <span class='cn'>FALSE</span>
|
||||
<span class='op'>)</span></pre>
|
||||
|
||||
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
|
||||
<table class="ref-arguments">
|
||||
@ -396,32 +396,32 @@ The <a href='lifecycle.html'>lifecycle</a> of this function is <strong>stable</s
|
||||
<span class='co'># See ?example_isolates.</span>
|
||||
|
||||
<span class='co'># output of the `key_antibiotics` function could be like this:</span>
|
||||
<span class='kw'>strainA</span> <span class='op'><-</span> <span class='st'>"SSSRR.S.R..S"</span>
|
||||
<span class='kw'>strainB</span> <span class='op'><-</span> <span class='st'>"SSSIRSSSRSSS"</span>
|
||||
<span class='va'>strainA</span> <span class='op'><-</span> <span class='st'>"SSSRR.S.R..S"</span>
|
||||
<span class='va'>strainB</span> <span class='op'><-</span> <span class='st'>"SSSIRSSSRSSS"</span>
|
||||
|
||||
<span class='co'># can those strings can be compared with:</span>
|
||||
<span class='fu'>key_antibiotics_equal</span>(<span class='kw'>strainA</span>, <span class='kw'>strainB</span>)
|
||||
<span class='fu'>key_antibiotics_equal</span><span class='op'>(</span><span class='va'>strainA</span>, <span class='va'>strainB</span><span class='op'>)</span>
|
||||
<span class='co'># TRUE, because I is ignored (as well as missing values)</span>
|
||||
|
||||
<span class='fu'>key_antibiotics_equal</span>(<span class='kw'>strainA</span>, <span class='kw'>strainB</span>, ignore_I = <span class='fl'>FALSE</span>)
|
||||
<span class='fu'>key_antibiotics_equal</span><span class='op'>(</span><span class='va'>strainA</span>, <span class='va'>strainB</span>, ignore_I <span class='op'>=</span> <span class='cn'>FALSE</span><span class='op'>)</span>
|
||||
<span class='co'># FALSE, because I is not ignored and so the 4th value differs</span>
|
||||
|
||||
<span class='co'># \donttest{</span>
|
||||
<span class='co'>if</span> (<span class='fu'><a href='https://rdrr.io/r/base/library.html'>require</a></span>(<span class='st'><a href='https://dplyr.tidyverse.org'>"dplyr"</a></span>)) {
|
||||
<span class='kw'>if</span> <span class='op'>(</span><span class='kw'><a href='https://rdrr.io/r/base/library.html'>require</a></span><span class='op'>(</span><span class='st'><a href='https://dplyr.tidyverse.org'>"dplyr"</a></span><span class='op'>)</span><span class='op'>)</span> <span class='op'>{</span>
|
||||
<span class='co'># set key antibiotics to a new variable</span>
|
||||
<span class='kw'>my_patients</span> <span class='op'><-</span> <span class='kw'>example_isolates</span> <span class='op'>%>%</span>
|
||||
<span class='fu'><a href='https://dplyr.tidyverse.org/reference/mutate.html'>mutate</a></span>(keyab = <span class='fu'>key_antibiotics</span>(<span class='kw'>.</span>)) <span class='op'>%>%</span>
|
||||
<span class='fu'><a href='https://dplyr.tidyverse.org/reference/mutate.html'>mutate</a></span>(
|
||||
<span class='va'>my_patients</span> <span class='op'><-</span> <span class='va'>example_isolates</span> <span class='op'>%>%</span>
|
||||
<span class='fu'><a href='https://dplyr.tidyverse.org/reference/mutate.html'>mutate</a></span><span class='op'>(</span>keyab <span class='op'>=</span> <span class='fu'>key_antibiotics</span><span class='op'>(</span><span class='va'>.</span><span class='op'>)</span><span class='op'>)</span> <span class='op'>%>%</span>
|
||||
<span class='fu'><a href='https://dplyr.tidyverse.org/reference/mutate.html'>mutate</a></span><span class='op'>(</span>
|
||||
<span class='co'># now calculate first isolates</span>
|
||||
first_regular = <span class='fu'><a href='first_isolate.html'>first_isolate</a></span>(<span class='kw'>.</span>, col_keyantibiotics = <span class='fl'>FALSE</span>),
|
||||
first_regular <span class='op'>=</span> <span class='fu'><a href='first_isolate.html'>first_isolate</a></span><span class='op'>(</span><span class='va'>.</span>, col_keyantibiotics <span class='op'>=</span> <span class='cn'>FALSE</span><span class='op'>)</span>,
|
||||
<span class='co'># and first WEIGHTED isolates</span>
|
||||
first_weighted = <span class='fu'><a href='first_isolate.html'>first_isolate</a></span>(<span class='kw'>.</span>, col_keyantibiotics = <span class='st'>"keyab"</span>)
|
||||
)
|
||||
first_weighted <span class='op'>=</span> <span class='fu'><a href='first_isolate.html'>first_isolate</a></span><span class='op'>(</span><span class='va'>.</span>, col_keyantibiotics <span class='op'>=</span> <span class='st'>"keyab"</span><span class='op'>)</span>
|
||||
<span class='op'>)</span>
|
||||
|
||||
<span class='co'># Check the difference, in this data set it results in 7% more isolates:</span>
|
||||
<span class='fu'><a href='https://rdrr.io/r/base/sum.html'>sum</a></span>(<span class='kw'>my_patients</span><span class='op'>$</span><span class='kw'>first_regular</span>, na.rm = <span class='fl'>TRUE</span>)
|
||||
<span class='fu'><a href='https://rdrr.io/r/base/sum.html'>sum</a></span>(<span class='kw'>my_patients</span><span class='op'>$</span><span class='kw'>first_weighted</span>, na.rm = <span class='fl'>TRUE</span>)
|
||||
}
|
||||
<span class='fu'><a href='https://rdrr.io/r/base/sum.html'>sum</a></span><span class='op'>(</span><span class='va'>my_patients</span><span class='op'>$</span><span class='va'>first_regular</span>, na.rm <span class='op'>=</span> <span class='cn'>TRUE</span><span class='op'>)</span>
|
||||
<span class='fu'><a href='https://rdrr.io/r/base/sum.html'>sum</a></span><span class='op'>(</span><span class='va'>my_patients</span><span class='op'>$</span><span class='va'>first_weighted</span>, na.rm <span class='op'>=</span> <span class='cn'>TRUE</span><span class='op'>)</span>
|
||||
<span class='op'>}</span>
|
||||
<span class='co'># }</span>
|
||||
</pre>
|
||||
</div>
|
||||
@ -439,7 +439,7 @@ The <a href='lifecycle.html'>lifecycle</a> of this function is <strong>stable</s
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.5.1.9000.</p>
|
||||
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
Reference in New Issue
Block a user