P281424/AMR
1
0
Fork 0
mirror of https://github.com/msberends/AMR.git synced 2026-05-31 15:41:47 +02:00
Code Releases Activity

Built site for AMR@3.0.1.9045: 8ff5d44

Browse Source
This commit is contained in:
github-actions
2026-04-21 20:03:58 +00:00
parent f2e56dbc61
commit 86b5ebf61f
105 changed files with 520 additions and 389 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
reference/AMR-deprecated.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

4
reference/AMR-options.html
View File

@@ -9,7 +9,7 @@ options(AMR_guideline = "CLSI")'><meta property="og:image" content="https://amr-
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -62,7 +62,7 @@ options(AMR_guideline = "CLSI")'><meta property="og:image" content="https://amr-
<ul><li><p><code>AMR_antibiogram_formatting_type</code> <br> A <a href="https://rdrr.io/r/base/numeric.html" class="external-link">numeric</a> (1-22) to use in <code><a href="antibiogram.html">antibiogram()</a></code>, to indicate which formatting type to use.</p></li>
<li><p><code>AMR_breakpoint_type</code> <br> A <a href="https://rdrr.io/r/base/character.html" class="external-link">character</a> to use in <code><a href="as.sir.html">as.sir()</a></code>, to indicate which breakpoint type to use. This must be either .val ECOFF, .val animal, or .val human.</p></li>
<li><p><code>AMR_breakpoint_type</code> <br> A <a href="https://rdrr.io/r/base/character.html" class="external-link">character</a> to use in <code><a href="as.sir.html">as.sir()</a></code>, to indicate which breakpoint type to use. This must be either <code>"ECOFF"</code>, <code>"animal"</code>, or <code>"human"</code>.</p></li>
<li><p><code>AMR_capped_mic_handling</code> <br> A <a href="https://rdrr.io/r/base/character.html" class="external-link">character</a> to use in <code><a href="as.sir.html">as.sir()</a></code>, to indicate how capped MIC values (<code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>) should be interpreted. Must be one of <code>"none"</code>, <code>"conservative"</code>, <code>"standard"</code>, or <code>"lenient"</code> - the default is <code>"conservative"</code>.</p></li>
<li><p><code>AMR_cleaning_regex</code> <br> A <a href="https://rdrr.io/r/base/regex.html" class="external-link">regular expression</a> (case-insensitive) to use in <code><a href="as.mo.html">as.mo()</a></code> and all <code><a href="mo_property.html">mo_*</a></code> functions, to clean the user input. The default is the outcome of <code><a href="as.mo.html">mo_cleaning_regex()</a></code>, which removes texts between brackets and texts such as "species" and "serovar".</p></li>
<li><p><code>AMR_custom_ab</code> <br> A file location to an RDS file, to use custom antimicrobial drugs with this package. This is explained in <code><a href="add_custom_antimicrobials.html">add_custom_antimicrobials()</a></code>.</p></li>

4
reference/AMR-options.md
View File

@@ -16,8 +16,8 @@ the `AMR` package. Set them using the
- `AMR_breakpoint_type`
A [character](https://rdrr.io/r/base/character.html) to use in
[`as.sir()`](https://amr-for-r.org/reference/as.sir.md), to indicate
which breakpoint type to use. This must be either .val ECOFF, .val
animal, or .val human.
which breakpoint type to use. This must be either `"ECOFF"`,
`"animal"`, or `"human"`.
- `AMR_capped_mic_handling`
A [character](https://rdrr.io/r/base/character.html) to use in

2
reference/AMR.html
View File

@@ -21,7 +21,7 @@ The AMR package is available in English, Arabic, Bengali, Chinese, Czech, Danish
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/WHOCC.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/WHONET.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/ab_from_text.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

4
reference/ab_property.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -124,7 +124,7 @@
<dt id="arg-property">property<a class="anchor" aria-label="anchor" href="#arg-property"></a></dt>
<dd><p>One of the column names of one of the <a href="antimicrobials.html">antimicrobials</a> data set: <code>vector_or(colnames(antimicrobials), sort = FALSE)</code>.</p></dd>
<dd><p>One of the column names of one of the <a href="antimicrobials.html">antimicrobials</a> data set: <code>"ab"</code>, <code>"cid"</code>, <code>"name"</code>, <code>"group"</code>, <code>"atc"</code>, <code>"atc_group1"</code>, <code>"atc_group2"</code>, <code>"abbreviations"</code>, <code>"synonyms"</code>, <code>"oral_ddd"</code>, <code>"oral_units"</code>, <code>"iv_ddd"</code>, <code>"iv_units"</code>, or <code>"loinc"</code>.</p></dd>
<dt id="arg-data">data<a class="anchor" aria-label="anchor" href="#arg-data"></a></dt>

4
reference/ab_property.md
View File

@@ -101,7 +101,9 @@ set_ab_names(data, ..., property = "name", language = get_AMR_locale(),
One of the column names of one of the
[antimicrobials](https://amr-for-r.org/reference/antimicrobials.md)
data set: `vector_or(colnames(antimicrobials), sort = FALSE)`.
data set: `"ab"`, `"cid"`, `"name"`, `"group"`, `"atc"`,
`"atc_group1"`, `"atc_group2"`, `"abbreviations"`, `"synonyms"`,
`"oral_ddd"`, `"oral_units"`, `"iv_ddd"`, `"iv_units"`, or `"loinc"`.
- data:

2
reference/add_custom_antimicrobials.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/add_custom_microorganisms.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

22
reference/age.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -112,16 +112,16 @@
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">df</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> birth_date age age_exact age_at_y2k</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 1 1999-06-30 26 26.76438 0</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 2 1968-01-29 58 58.18082 31</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 3 1965-12-05 60 60.33151 34</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 4 1980-03-01 46 46.09589 19</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 5 1949-11-01 76 76.42466 50</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 6 1947-02-14 79 79.13699 52</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 7 1940-02-19 86 86.12329 59</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 8 1988-01-10 38 38.23288 11</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 9 1997-08-27 28 28.60548 2</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 10 1978-01-26 48 48.18904 21</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 1 1999-06-30 26 26.80822 0</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 2 1968-01-29 58 58.22466 31</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 3 1965-12-05 60 60.37534 34</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 4 1980-03-01 46 46.13973 19</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 5 1949-11-01 76 76.46849 50</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 6 1947-02-14 79 79.18082 52</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 7 1940-02-19 86 86.16712 59</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 8 1988-01-10 38 38.27671 11</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 9 1997-08-27 28 28.64932 2</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 10 1978-01-26 48 48.23288 21</span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>

20
reference/age.md
View File

@@ -81,14 +81,14 @@ df$age_at_y2k <- age(df$birth_date, "2000-01-01")
df
#> birth_date age age_exact age_at_y2k
#> 1 1999-06-30 26 26.76438 0
#> 2 1968-01-29 58 58.18082 31
#> 3 1965-12-05 60 60.33151 34
#> 4 1980-03-01 46 46.09589 19
#> 5 1949-11-01 76 76.42466 50
#> 6 1947-02-14 79 79.13699 52
#> 7 1940-02-19 86 86.12329 59
#> 8 1988-01-10 38 38.23288 11
#> 9 1997-08-27 28 28.60548 2
#> 10 1978-01-26 48 48.18904 21
#> 1 1999-06-30 26 26.80822 0
#> 2 1968-01-29 58 58.22466 31
#> 3 1965-12-05 60 60.37534 34
#> 4 1980-03-01 46 46.13973 19
#> 5 1949-11-01 76 76.46849 50
#> 6 1947-02-14 79 79.18082 52
#> 7 1940-02-19 86 86.16712 59
#> 8 1988-01-10 38 38.27671 11
#> 9 1997-08-27 28 28.64932 2
#> 10 1978-01-26 48 48.23288 21
```

2
reference/age_groups.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

12
reference/amr-tidymodels.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -188,12 +188,12 @@ may affect the computations for subsequent operations.</p></dd>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Loading required package: tidymodels</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> ── <span style="font-weight: bold;">Attaching packages</span> ────────────────────────────────────── tidymodels 1.4.1 ──</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">broom </span> 1.0.12 <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">rsample </span> 1.3.2 </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">dials </span> 1.4.2 <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">tailor </span> 0.1.0 </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">dials </span> 1.4.3 <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">tailor </span> 0.1.0 </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">infer </span> 1.1.0 <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">tidyr </span> 1.3.2 </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">modeldata </span> 1.5.1 <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">tune </span> 2.0.1 </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">parsnip </span> 1.4.1 <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">workflows </span> 1.3.0 </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">purrr </span> 1.2.1 <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">workflowsets</span> 1.1.1 </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">recipes </span> 1.3.2 <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">yardstick </span> 1.3.2 </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">modeldata </span> 1.5.1 <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">tune </span> 2.1.0 </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">parsnip </span> 1.5.0 <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">workflows </span> 1.3.0 </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">purrr </span> 1.2.2 <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">workflowsets</span> 1.1.1 </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">recipes </span> 1.3.2 <span style="color: #00BB00;">✔</span> <span style="color: #0000BB;">yardstick </span> 1.4.0 </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> ── <span style="font-weight: bold;">Conflicts</span> ───────────────────────────────────────── tidymodels_conflicts() ──</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #BB0000;">✖</span> <span style="color: #0000BB;">purrr</span>::<span style="color: #00BB00;">discard()</span> masks <span style="color: #0000BB;">scales</span>::discard()</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #BB0000;">✖</span> <span style="color: #0000BB;">dplyr</span>::<span style="color: #00BB00;">filter()</span> masks <span style="color: #0000BB;">stats</span>::filter()</span>

10
reference/amr-tidymodels.md
View File

@@ -167,12 +167,12 @@ if (require("tidymodels")) {
#> Loading required package: tidymodels
#> ── Attaching packages ────────────────────────────────────── tidymodels 1.4.1 ──
#> ✔ broom 1.0.12 ✔ rsample 1.3.2
#> ✔ dials 1.4.2 ✔ tailor 0.1.0
#> ✔ dials 1.4.3 ✔ tailor 0.1.0
#> ✔ infer 1.1.0 ✔ tidyr 1.3.2
#> ✔ modeldata 1.5.1 ✔ tune 2.0.1
#> ✔ parsnip 1.4.1 ✔ workflows 1.3.0
#> ✔ purrr 1.2.1 ✔ workflowsets 1.1.1
#> ✔ recipes 1.3.2 ✔ yardstick 1.3.2
#> ✔ modeldata 1.5.1 ✔ tune 2.1.0
#> ✔ parsnip 1.5.0 ✔ workflows 1.3.0
#> ✔ purrr 1.2.2 ✔ workflowsets 1.1.1
#> ✔ recipes 1.3.2 ✔ yardstick 1.4.0
#> ── Conflicts ───────────────────────────────────────── tidymodels_conflicts() ──
#> ✖ purrr::discard() masks scales::discard()
#> ✖ dplyr::filter() masks stats::filter()

2
reference/amr_course.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

6
reference/antibiogram.html
View File

@@ -9,7 +9,7 @@ Adhering to previously described approaches (see Source) and especially the Baye
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -123,11 +123,11 @@ Adhering to previously described approaches (see Source) and especially the Baye
<dt id="arg-mo-transform">mo_transform<a class="anchor" aria-label="anchor" href="#arg-mo-transform"></a></dt>
<dd><p>A character to transform microorganism input - must be <code>"name"</code>, <code>"shortname"</code> (default), <code>"gramstain"</code>, or one of the column names of the <a href="microorganisms.html">microorganisms</a> data set: .val mo, .val fullname, .val status, .val kingdom, .val phylum, .val class, .val order, .val family, .val genus, .val species, .val subspecies, .val rank, .val ref, .val oxygen_tolerance, .val source, .val lpsn, .val lpsn_parent, .val lpsn_renamed_to, .val mycobank, .val mycobank_parent, .val mycobank_renamed_to, .val gbif, .val gbif_parent, .val gbif_renamed_to, .val prevalence, or .val snomed. Can also be <code>NULL</code> to not transform the input or <code>NA</code> to consider all microorganisms 'unknown'.</p></dd>
<dd><p>A character to transform microorganism input - must be <code>"name"</code>, <code>"shortname"</code> (default), <code>"gramstain"</code>, or one of the column names of the <a href="microorganisms.html">microorganisms</a> data set: <code>"mo"</code>, <code>"fullname"</code>, <code>"status"</code>, <code>"kingdom"</code>, <code>"phylum"</code>, <code>"class"</code>, <code>"order"</code>, <code>"family"</code>, <code>"genus"</code>, <code>"species"</code>, <code>"subspecies"</code>, <code>"rank"</code>, <code>"ref"</code>, <code>"oxygen_tolerance"</code>, <code>"source"</code>, <code>"lpsn"</code>, <code>"lpsn_parent"</code>, <code>"lpsn_renamed_to"</code>, <code>"mycobank"</code>, <code>"mycobank_parent"</code>, <code>"mycobank_renamed_to"</code>, <code>"gbif"</code>, <code>"gbif_parent"</code>, <code>"gbif_renamed_to"</code>, <code>"prevalence"</code>, or <code>"snomed"</code>. Can also be <code>NULL</code> to not transform the input or <code>NA</code> to consider all microorganisms 'unknown'.</p></dd>
<dt id="arg-ab-transform">ab_transform<a class="anchor" aria-label="anchor" href="#arg-ab-transform"></a></dt>
<dd><p>A character to transform antimicrobial input - must be one of the column names of the <a href="antimicrobials.html">antimicrobials</a> data set (defaults to <code>"name"</code>): .val ab, .val cid, .val name, .val group, .val atc, .val atc_group1, .val atc_group2, .val abbreviations, .val synonyms, .val oral_ddd, .val oral_units, .val iv_ddd, .val iv_units, or .val loinc. Can also be <code>NULL</code> to not transform the input.</p></dd>
<dd><p>A character to transform antimicrobial input - must be one of the column names of the <a href="antimicrobials.html">antimicrobials</a> data set (defaults to <code>"name"</code>): <code>"ab"</code>, <code>"cid"</code>, <code>"name"</code>, <code>"group"</code>, <code>"atc"</code>, <code>"atc_group1"</code>, <code>"atc_group2"</code>, <code>"abbreviations"</code>, <code>"synonyms"</code>, <code>"oral_ddd"</code>, <code>"oral_units"</code>, <code>"iv_ddd"</code>, <code>"iv_units"</code>, or <code>"loinc"</code>. Can also be <code>NULL</code> to not transform the input.</p></dd>
<dt id="arg-syndromic-group">syndromic_group<a class="anchor" aria-label="anchor" href="#arg-syndromic-group"></a></dt>

25
reference/antibiogram.md
View File

@@ -132,25 +132,24 @@ knit_print(x, italicise = TRUE,
`"shortname"` (default), `"gramstain"`, or one of the column names of
the
[microorganisms](https://amr-for-r.org/reference/microorganisms.md)
data set: .val mo, .val fullname, .val status, .val kingdom, .val
phylum, .val class, .val order, .val family, .val genus, .val species,
.val subspecies, .val rank, .val ref, .val oxygen_tolerance, .val
source, .val lpsn, .val lpsn_parent, .val lpsn_renamed_to, .val
mycobank, .val mycobank_parent, .val mycobank_renamed_to, .val gbif,
.val gbif_parent, .val gbif_renamed_to, .val prevalence, or .val
snomed. Can also be `NULL` to not transform the input or `NA` to
consider all microorganisms 'unknown'.
data set: `"mo"`, `"fullname"`, `"status"`, `"kingdom"`, `"phylum"`,
`"class"`, `"order"`, `"family"`, `"genus"`, `"species"`,
`"subspecies"`, `"rank"`, `"ref"`, `"oxygen_tolerance"`, `"source"`,
`"lpsn"`, `"lpsn_parent"`, `"lpsn_renamed_to"`, `"mycobank"`,
`"mycobank_parent"`, `"mycobank_renamed_to"`, `"gbif"`,
`"gbif_parent"`, `"gbif_renamed_to"`, `"prevalence"`, or `"snomed"`.
Can also be `NULL` to not transform the input or `NA` to consider all
microorganisms 'unknown'.
- ab_transform:
A character to transform antimicrobial input - must be one of the
column names of the
[antimicrobials](https://amr-for-r.org/reference/antimicrobials.md)
data set (defaults to `"name"`): .val ab, .val cid, .val name, .val
group, .val atc, .val atc_group1, .val atc_group2, .val abbreviations,
.val synonyms, .val oral_ddd, .val oral_units, .val iv_ddd, .val
iv_units, or .val loinc. Can also be `NULL` to not transform the
input.
data set (defaults to `"name"`): `"ab"`, `"cid"`, `"name"`, `"group"`,
`"atc"`, `"atc_group1"`, `"atc_group2"`, `"abbreviations"`,
`"synonyms"`, `"oral_ddd"`, `"oral_units"`, `"iv_ddd"`, `"iv_units"`,
or `"loinc"`. Can also be `NULL` to not transform the input.
- syndromic_group:

4
reference/antimicrobial_selectors.html
View File

@@ -17,7 +17,7 @@ my_data_with_all_these_columns %&amp;gt;%
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -200,7 +200,7 @@ my_data_with_all_these_columns %&amp;gt;%
<dt id="arg-version-expected-phenotypes">version_expected_phenotypes<a class="anchor" aria-label="anchor" href="#arg-version-expected-phenotypes"></a></dt>
<dd><p>The version number to use for the EUCAST Expected Phenotypes. Can be .val 1.2.</p></dd>
<dd><p>The version number to use for the EUCAST Expected Phenotypes. Can be <code>"1.2"</code>.</p></dd>
</dl></div>
<div class="section level2">

2
reference/antimicrobial_selectors.md
View File

@@ -170,7 +170,7 @@ not_intrinsic_resistant(only_sir_columns = FALSE, col_mo = NULL,
- version_expected_phenotypes:
The version number to use for the EUCAST Expected Phenotypes. Can be
.val 1.2.
`"1.2"`.
## Value

2
reference/antimicrobials.html
View File

@@ -9,7 +9,7 @@ The antibiotics data set has been renamed to antimicrobials. The old name will b
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/as.ab.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/as.av.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/as.disk.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/as.mic.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/as.mo.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

12
reference/as.sir.html
View File

@@ -9,7 +9,7 @@ Breakpoints are currently implemented from EUCAST 2011-2026 and CLSI 2011-2026,
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -203,7 +203,7 @@ Breakpoints are currently implemented from EUCAST 2011-2026 and CLSI 2011-2026,
<dt id="arg-breakpoint-type">breakpoint_type<a class="anchor" aria-label="anchor" href="#arg-breakpoint-type"></a></dt>
<dd><p>The type of breakpoints to use, either .val ECOFF, .val animal, or .val human. ECOFF stands for Epidemiological Cut-Off values. The default is <code>"human"</code>, which can also be set with the package option <code><a href="AMR-options.html">AMR_breakpoint_type</a></code>. If <code>host</code> is set to values of veterinary species, this will automatically be set to <code>"animal"</code>.</p></dd>
<dd><p>The type of breakpoints to use, either <code>"ECOFF"</code>, <code>"animal"</code>, or <code>"human"</code>. ECOFF stands for Epidemiological Cut-Off values. The default is <code>"human"</code>, which can also be set with the package option <code><a href="AMR-options.html">AMR_breakpoint_type</a></code>. If <code>host</code> is set to values of veterinary species, this will automatically be set to <code>"animal"</code>.</p></dd>
<dt id="arg-host">host<a class="anchor" aria-label="anchor" href="#arg-host"></a></dt>
@@ -424,10 +424,10 @@ Breakpoints are currently implemented from EUCAST 2011-2026 and CLSI 2011-2026,
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494;"># A tibble: 4 × 18</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> datetime index method ab_given mo_given host_given input_given</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dttm&gt;</span> <span style="color: #949494; font-style: italic;">&lt;int&gt;</span> <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">1</span> 2026-04-05 <span style="color: #949494;">15:32:33</span> 1 MIC amoxicillin Escherich… human 8 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">2</span> 2026-04-05 <span style="color: #949494;">15:32:33</span> 1 MIC cipro Escherich… human 0.256 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">3</span> 2026-04-05 <span style="color: #949494;">15:32:33</span> 1 DISK tobra Escherich… human 16 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">4</span> 2026-04-05 <span style="color: #949494;">15:32:33</span> 1 DISK genta Escherich… human 18 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">1</span> 2026-04-21 <span style="color: #949494;">19:59:41</span> 1 MIC amoxicillin Escherich… human 8 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">2</span> 2026-04-21 <span style="color: #949494;">19:59:42</span> 1 MIC cipro Escherich… human 0.256 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">3</span> 2026-04-21 <span style="color: #949494;">19:59:42</span> 1 DISK tobra Escherich… human 16 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">4</span> 2026-04-21 <span style="color: #949494;">19:59:42</span> 1 DISK genta Escherich… human 18 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494;"># ℹ 11 more variables: ab &lt;ab&gt;, mo &lt;mo&gt;, host &lt;chr&gt;, input &lt;chr&gt;,</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494;"># outcome &lt;sir&gt;, notes &lt;chr&gt;, guideline &lt;chr&gt;, ref_table &lt;chr&gt;, uti &lt;lgl&gt;,</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494;"># breakpoint_S_R &lt;chr&gt;, site &lt;chr&gt;</span></span>

12
reference/as.sir.md
View File

@@ -280,8 +280,8 @@ disk diffusion diameters:
- breakpoint_type:
The type of breakpoints to use, either .val ECOFF, .val animal, or
.val human. ECOFF stands for Epidemiological Cut-Off values. The
The type of breakpoints to use, either `"ECOFF"`, `"animal"`, or
`"human"`. ECOFF stands for Epidemiological Cut-Off values. The
default is `"human"`, which can also be set with the package option
[`AMR_breakpoint_type`](https://amr-for-r.org/reference/AMR-options.md).
If `host` is set to values of veterinary species, this will
@@ -660,10 +660,10 @@ sir_interpretation_history()
#> # A tibble: 4 × 18
#> datetime index method ab_given mo_given host_given input_given
#> <dttm> <int> <chr> <chr> <chr> <chr> <chr>
#> 1 2026-04-05 15:32:33 1 MIC amoxicillin Escherich… human 8
#> 2 2026-04-05 15:32:33 1 MIC cipro Escherich… human 0.256
#> 3 2026-04-05 15:32:33 1 DISK tobra Escherich… human 16
#> 4 2026-04-05 15:32:33 1 DISK genta Escherich… human 18
#> 1 2026-04-21 19:59:41 1 MIC amoxicillin Escherich… human 8
#> 2 2026-04-21 19:59:42 1 MIC cipro Escherich… human 0.256
#> 3 2026-04-21 19:59:42 1 DISK tobra Escherich… human 16
#> 4 2026-04-21 19:59:42 1 DISK genta Escherich… human 18
#> # ℹ 11 more variables: ab <ab>, mo <mo>, host <chr>, input <chr>,
#> # outcome <sir>, notes <chr>, guideline <chr>, ref_table <chr>, uti <lgl>,
#> # breakpoint_S_R <chr>, site <chr>

2
reference/atc_online.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/av_from_text.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

4
reference/av_property.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -109,7 +109,7 @@
<dt id="arg-property">property<a class="anchor" aria-label="anchor" href="#arg-property"></a></dt>
<dd><p>One of the column names of one of the <a href="antimicrobials.html">antivirals</a> data set: <code>vector_or(colnames(antivirals), sort = FALSE)</code>.</p></dd>
<dd><p>One of the column names of one of the <a href="antimicrobials.html">antivirals</a> data set: <code>"av"</code>, <code>"name"</code>, <code>"atc"</code>, <code>"cid"</code>, <code>"atc_group"</code>, <code>"synonyms"</code>, <code>"oral_ddd"</code>, <code>"oral_units"</code>, <code>"iv_ddd"</code>, <code>"iv_units"</code>, or <code>"loinc"</code>.</p></dd>
</dl></div>
<div class="section level2">

3
reference/av_property.md
View File

@@ -73,7 +73,8 @@ av_property(x, property = "name", language = get_AMR_locale(), ...)
One of the column names of one of the
[antivirals](https://amr-for-r.org/reference/antimicrobials.md) data
set: `vector_or(colnames(antivirals), sort = FALSE)`.
set: `"av"`, `"name"`, `"atc"`, `"cid"`, `"atc_group"`, `"synonyms"`,
`"oral_ddd"`, `"oral_units"`, `"iv_ddd"`, `"iv_units"`, or `"loinc"`.
## Value

2
reference/availability.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/bug_drug_combinations.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

8
reference/clinical_breakpoints.html
View File

@@ -21,7 +21,7 @@ Use as.sir() to transform MICs or disks measurements to SIR values."><meta prope
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -79,9 +79,9 @@ Use as.sir() to transform MICs or disks measurements to SIR values."><meta prope
<div class="section level2">
<h2 id="format">Format<a class="anchor" aria-label="anchor" href="#format"></a></h2>
<p>A <a href="https://tibble.tidyverse.org/reference/tibble.html" class="external-link">tibble</a> with 45 730 observations and 14 variables:</p><ul><li><p><code>guideline</code><br> Name of the guideline</p></li>
<li><p><code>type</code><br> Breakpoint type, either .val ECOFF, .val animal, or .val human</p></li>
<li><p><code>host</code><br> Host of infectious agent. This is mostly useful for veterinary breakpoints and is either .val ECOFF, .val aquatic, .val cats, .val cattle, .val dogs, .val horse, .val human, .val poultry, or .val swine</p></li>
<li><p><code>method</code><br> Testing method, either .val DISK or .val MIC</p></li>
<li><p><code>type</code><br> Breakpoint type, either <code>"ECOFF"</code>, <code>"animal"</code>, or <code>"human"</code></p></li>
<li><p><code>host</code><br> Host of infectious agent. This is mostly useful for veterinary breakpoints and is either <code>"ECOFF"</code>, <code>"aquatic"</code>, <code>"cats"</code>, <code>"cattle"</code>, <code>"dogs"</code>, <code>"horse"</code>, <code>"human"</code>, <code>"poultry"</code>, or <code>"swine"</code></p></li>
<li><p><code>method</code><br> Testing method, either <code>"DISK"</code> or <code>"MIC"</code></p></li>
<li><p><code>site</code><br> Body site for which the breakpoint must be applied, e.g. "Oral" or "Respiratory"</p></li>
<li><p><code>mo</code><br> Microbial ID, see <code><a href="as.mo.html">as.mo()</a></code></p></li>
<li><p><code>rank_index</code><br> Taxonomic rank index of <code>mo</code> from 1 (subspecies/infraspecies) to 5 (unknown microorganism)</p></li>

8
reference/clinical_breakpoints.md
View File

@@ -32,15 +32,15 @@ A [tibble](https://tibble.tidyverse.org/reference/tibble.html) with 45
Name of the guideline
- `type`
Breakpoint type, either .val ECOFF, .val animal, or .val human
Breakpoint type, either `"ECOFF"`, `"animal"`, or `"human"`
- `host`
Host of infectious agent. This is mostly useful for veterinary
breakpoints and is either .val ECOFF, .val aquatic, .val cats, .val
cattle, .val dogs, .val horse, .val human, .val poultry, or .val swine
breakpoints and is either `"ECOFF"`, `"aquatic"`, `"cats"`,
`"cattle"`, `"dogs"`, `"horse"`, `"human"`, `"poultry"`, or `"swine"`
- `method`
Testing method, either .val DISK or .val MIC
Testing method, either `"DISK"` or `"MIC"`
- `site`
Body site for which the breakpoint must be applied, e.g. "Oral" or

2
reference/count.html
View File

@@ -9,7 +9,7 @@ count_resistant() should be used to count resistant isolates, count_susceptible(
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

4
reference/custom_eucast_rules.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -112,7 +112,7 @@
<h3 id="using-taxonomic-properties-in-rules">Using taxonomic properties in rules<a class="anchor" aria-label="anchor" href="#using-taxonomic-properties-in-rules"></a></h3>
<p>There is one exception in columns used for the rules: all column names of the <a href="microorganisms.html">microorganisms</a> data set can also be used, but do not have to exist in the data set. These column names are: "mo", "fullname", "status", "kingdom", "phylum", "class", "order", "family", "genus", "species", "subspecies", "rank", "ref", "oxygen_tolerance", "source", "lpsn", "lpsn_parent", "lpsn_renamed_to", "mycobank", "mycobank_parent", "mycobank_renamed_to", "gbif", "gbif_parent", "gbif_renamed_to", "prevalence", and "snomed". Thus, this next example will work as well, despite the fact that the <code>df</code> data set does not contain a column <code>genus</code>:</p>
<p>There is one exception in columns used for the rules: all column names of the <a href="microorganisms.html">microorganisms</a> data set can also be used, but do not have to exist in the data set. These column names are: <code>"mo"</code>, <code>"fullname"</code>, <code>"status"</code>, <code>"kingdom"</code>, <code>"phylum"</code>, <code>"class"</code>, <code>"order"</code>, <code>"family"</code>, <code>"genus"</code>, <code>"species"</code>, <code>"subspecies"</code>, <code>"rank"</code>, <code>"ref"</code>, <code>"oxygen_tolerance"</code>, <code>"source"</code>, <code>"lpsn"</code>, <code>"lpsn_parent"</code>, <code>"lpsn_renamed_to"</code>, <code>"mycobank"</code>, <code>"mycobank_parent"</code>, <code>"mycobank_renamed_to"</code>, <code>"gbif"</code>, <code>"gbif_parent"</code>, <code>"gbif_renamed_to"</code>, <code>"prevalence"</code>, and <code>"snomed"</code>. Thus, this next example will work as well, despite the fact that the <code>df</code> data set does not contain a column <code>genus</code>:</p>
<p></p><div class="sourceCode r"><pre><code><span><span class="va">y</span> <span class="op">&lt;-</span> <span class="fu"><a href="../reference/custom_eucast_rules.html">custom_eucast_rules</a></span><span class="op">(</span></span>
<span> <span class="va">TZP</span> <span class="op">==</span> <span class="st">"S"</span> <span class="op">&amp;</span> <span class="va">genus</span> <span class="op">==</span> <span class="st">"Klebsiella"</span> <span class="op">~</span> <span class="va">aminopenicillins</span> <span class="op">==</span> <span class="st">"S"</span>,</span>
<span> <span class="va">TZP</span> <span class="op">==</span> <span class="st">"R"</span> <span class="op">&amp;</span> <span class="va">genus</span> <span class="op">==</span> <span class="st">"Klebsiella"</span> <span class="op">~</span> <span class="va">aminopenicillins</span> <span class="op">==</span> <span class="st">"R"</span></span>

15
reference/custom_eucast_rules.md
View File

@@ -85,13 +85,14 @@ There is one exception in columns used for the rules: all column names
of the
[microorganisms](https://amr-for-r.org/reference/microorganisms.md) data
set can also be used, but do not have to exist in the data set. These
column names are: "mo", "fullname", "status", "kingdom", "phylum",
"class", "order", "family", "genus", "species", "subspecies", "rank",
"ref", "oxygen_tolerance", "source", "lpsn", "lpsn_parent",
"lpsn_renamed_to", "mycobank", "mycobank_parent", "mycobank_renamed_to",
"gbif", "gbif_parent", "gbif_renamed_to", "prevalence", and "snomed".
Thus, this next example will work as well, despite the fact that the
`df` data set does not contain a column `genus`:
column names are: `"mo"`, `"fullname"`, `"status"`, `"kingdom"`,
`"phylum"`, `"class"`, `"order"`, `"family"`, `"genus"`, `"species"`,
`"subspecies"`, `"rank"`, `"ref"`, `"oxygen_tolerance"`, `"source"`,
`"lpsn"`, `"lpsn_parent"`, `"lpsn_renamed_to"`, `"mycobank"`,
`"mycobank_parent"`, `"mycobank_renamed_to"`, `"gbif"`, `"gbif_parent"`,
`"gbif_renamed_to"`, `"prevalence"`, and `"snomed"`. Thus, this next
example will work as well, despite the fact that the `df` data set does
not contain a column `genus`:
y <- custom_eucast_rules(
TZP == "S" & genus == "Klebsiella" ~ aminopenicillins == "S",

2
reference/custom_mdro_guideline.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

6
reference/dosage.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -62,10 +62,10 @@
<h2 id="format">Format<a class="anchor" aria-label="anchor" href="#format"></a></h2>
<p>A <a href="https://tibble.tidyverse.org/reference/tibble.html" class="external-link">tibble</a> with 759 observations and 9 variables:</p><ul><li><p><code>ab</code><br> Antimicrobial ID as used in this package (such as <code>AMC</code>), using the official EARS-Net (European Antimicrobial Resistance Surveillance Network) codes where available</p></li>
<li><p><code>name</code><br> Official name of the antimicrobial drug as used by WHONET/EARS-Net or the WHO</p></li>
<li><p><code>type</code><br> Type of the dosage, either .val high_dosage, .val standard_dosage, or .val uncomplicated_uti</p></li>
<li><p><code>type</code><br> Type of the dosage, either <code>"high_dosage"</code>, <code>"standard_dosage"</code>, or <code>"uncomplicated_uti"</code></p></li>
<li><p><code>dose</code><br> Dose, such as "2 g" or "25 mg/kg"</p></li>
<li><p><code>dose_times</code><br> Number of times a dose must be administered</p></li>
<li><p><code>administration</code><br> Route of administration, either .val , .val im, .val iv, .val oral, or NA</p></li>
<li><p><code>administration</code><br> Route of administration, either <code>""</code>, <code>"im"</code>, <code>"iv"</code>, <code>"oral"</code>, or NA</p></li>
<li><p><code>notes</code><br> Additional dosage notes</p></li>
<li><p><code>original_txt</code><br> Original text in the PDF file of EUCAST</p></li>
<li><p><code>eucast_version</code><br> Version number of the EUCAST Clinical Breakpoints guideline to which these dosages apply, either 15, 14, 13.1, 12, or 11</p></li>

7
reference/dosage.md
View File

@@ -25,8 +25,8 @@ observations and 9 variables:
the WHO
- `type`
Type of the dosage, either .val high_dosage, .val standard_dosage, or
.val uncomplicated_uti
Type of the dosage, either `"high_dosage"`, `"standard_dosage"`, or
`"uncomplicated_uti"`
- `dose`
Dose, such as "2 g" or "25 mg/kg"
@@ -35,8 +35,7 @@ observations and 9 variables:
Number of times a dose must be administered
- `administration`
Route of administration, either .val , .val im, .val iv, .val oral, or
NA
Route of administration, either `""`, `"im"`, `"iv"`, `"oral"`, or NA
- `notes`
Additional dosage notes

2
reference/esbl_isolates.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

6
reference/example_isolates.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -63,8 +63,8 @@
<p>A <a href="https://tibble.tidyverse.org/reference/tibble.html" class="external-link">tibble</a> with 2 000 observations and 46 variables:</p><ul><li><p><code>date</code><br> Date of receipt at the laboratory</p></li>
<li><p><code>patient</code><br> ID of the patient</p></li>
<li><p><code>age</code><br> Age of the patient</p></li>
<li><p><code>gender</code><br> Gender of the patient, either .val F or .val M</p></li>
<li><p><code>ward</code><br> Ward type where the patient was admitted, either .val Clinical, .val ICU, or .val Outpatient</p></li>
<li><p><code>gender</code><br> Gender of the patient, either <code>"F"</code> or <code>"M"</code></p></li>
<li><p><code>ward</code><br> Ward type where the patient was admitted, either <code>"Clinical"</code>, <code>"ICU"</code>, or <code>"Outpatient"</code></p></li>
<li><p><code>mo</code><br> ID of microorganism created with <code><a href="as.mo.html">as.mo()</a></code>, see also the <a href="microorganisms.html">microorganisms</a> data set</p></li>
<li><p><code>PEN:RIF</code><br> 40 different antimicrobials with class <code><a href="as.sir.html">sir</a></code> (see <code><a href="as.sir.html">as.sir()</a></code>); these column names occur in the <a href="antimicrobials.html">antimicrobials</a> data set and can be translated with <code><a href="ab_property.html">set_ab_names()</a></code> or <code><a href="ab_property.html">ab_name()</a></code></p></li>
</ul></div>

6
reference/example_isolates.md
View File

@@ -27,11 +27,11 @@ A [tibble](https://tibble.tidyverse.org/reference/tibble.html) with 2
Age of the patient
- `gender`
Gender of the patient, either .val F or .val M
Gender of the patient, either `"F"` or `"M"`
- `ward`
Ward type where the patient was admitted, either .val Clinical, .val
ICU, or .val Outpatient
Ward type where the patient was admitted, either `"Clinical"`,
`"ICU"`, or `"Outpatient"`
- `mo`
ID of microorganism created with

2
reference/example_isolates_unclean.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/export_ncbi_biosample.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/first_isolate.html
View File

@@ -9,7 +9,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/g.test.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/get_episode.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/ggplot_pca.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/ggplot_sir.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/guess_ab_col.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/index.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

36
reference/interpretive_rules.html
View File

@@ -9,7 +9,7 @@ To improve the interpretation of the antibiogram before CLSI/EUCAST interpretive
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -64,7 +64,7 @@ To improve the interpretation of the antibiogram before CLSI/EUCAST interpretive
<span> verbose <span class="op">=</span> <span class="cn">FALSE</span>, version_breakpoints <span class="op">=</span> <span class="fl">16</span>,</span>
<span> version_expected_phenotypes <span class="op">=</span> <span class="fl">1.2</span>, version_expertrules <span class="op">=</span> <span class="fl">3.3</span>,</span>
<span> ampc_cephalosporin_resistance <span class="op">=</span> <span class="cn">NA</span>, only_sir_columns <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/any.html" class="external-link">any</a></span><span class="op">(</span><span class="fu"><a href="as.sir.html">is.sir</a></span><span class="op">(</span><span class="va">x</span><span class="op">)</span><span class="op">)</span>,</span>
<span> custom_rules <span class="op">=</span> <span class="cn">NULL</span>, overwrite <span class="op">=</span> <span class="cn">FALSE</span>, <span class="va">...</span><span class="op">)</span></span>
<span> custom_rules <span class="op">=</span> <span class="cn">NULL</span>, overwrite <span class="op">=</span> <span class="cn">FALSE</span>, add_if_missing <span class="op">=</span> <span class="cn">TRUE</span>, <span class="va">...</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">eucast_rules</span><span class="op">(</span><span class="va">x</span>, col_mo <span class="op">=</span> <span class="cn">NULL</span>, info <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/interactive.html" class="external-link">interactive</a></span><span class="op">(</span><span class="op">)</span>,</span>
<span> rules <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">getOption</a></span><span class="op">(</span><span class="st">"AMR_interpretive_rules"</span>, default <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="st">"breakpoints"</span>,</span>
@@ -119,15 +119,15 @@ Leclercq et al. <strong>EUCAST expert rules in antimicrobial susceptibility test
<dt id="arg-version-breakpoints">version_breakpoints<a class="anchor" aria-label="anchor" href="#arg-version-breakpoints"></a></dt>
<dd><p>The version number to use for the EUCAST Clinical Breakpoints guideline. Can be .val 16.0, .val 15.0, .val 14.0, .val 13.1, .val 12.0, .val 11.0, or .val 10.0.</p></dd>
<dd><p>The version number to use for the EUCAST Clinical Breakpoints guideline. Can be <code>"16.0"</code>, <code>"15.0"</code>, <code>"14.0"</code>, <code>"13.1"</code>, <code>"12.0"</code>, <code>"11.0"</code>, or <code>"10.0"</code>.</p></dd>
<dt id="arg-version-expected-phenotypes">version_expected_phenotypes<a class="anchor" aria-label="anchor" href="#arg-version-expected-phenotypes"></a></dt>
<dd><p>The version number to use for the EUCAST Expected Phenotypes. Can be .val 1.2.</p></dd>
<dd><p>The version number to use for the EUCAST Expected Phenotypes. Can be <code>"1.2"</code>.</p></dd>
<dt id="arg-version-expertrules">version_expertrules<a class="anchor" aria-label="anchor" href="#arg-version-expertrules"></a></dt>
<dd><p>The version number to use for the EUCAST Expert Rules and Intrinsic Resistance guideline. Can be .val 3.3, .val 3.2, or .val 3.1.</p></dd>
<dd><p>The version number to use for the EUCAST Expert Rules and Intrinsic Resistance guideline. Can be <code>"3.3"</code>, <code>"3.2"</code>, or <code>"3.1"</code>.</p></dd>
<dt id="arg-ampc-cephalosporin-resistance">ampc_cephalosporin_resistance<a class="anchor" aria-label="anchor" href="#arg-ampc-cephalosporin-resistance"></a></dt>
@@ -146,6 +146,10 @@ Leclercq et al. <strong>EUCAST expert rules in antimicrobial susceptibility test
<dd><p>A <a href="https://rdrr.io/r/base/logical.html" class="external-link">logical</a> indicating whether to overwrite existing SIR values (default: <code>FALSE</code>). When <code>FALSE</code>, only non-SIR values are modified (i.e., any value that is not already S, I or R). To ensure compliance with EUCAST guidelines, <strong>this should remain</strong> <code>FALSE</code>, as EUCAST notes often state that an organism "should be tested for susceptibility to individual agents or be reported resistant".</p></dd>
<dt id="arg-add-if-missing">add_if_missing<a class="anchor" aria-label="anchor" href="#arg-add-if-missing"></a></dt>
<dd><p>A <a href="https://rdrr.io/r/base/logical.html" class="external-link">logical</a> indicating whether rules should also be applied to missing (<code>NA</code>) values (default: <code>TRUE</code>). When <code>FALSE</code>, rules are only applied to cells that already contain an SIR value; cells with <code>NA</code> are left untouched. This is particularly useful when using <code>overwrite = TRUE</code> with custom rules and you want to update reported results without imputing values for untested drugs.</p></dd>
<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p>Column names of antimicrobials. To automatically detect antimicrobial column names, do not provide any named arguments; <code><a href="guess_ab_col.html">guess_ab_col()</a></code> will then be used for detection. To manually specify a column, provide its name (case-insensitive) as an argument, e.g. <code>AMX = "amoxicillin"</code>. To skip a specific antimicrobial, set it to <code>NULL</code>, e.g. <code>TIC = NULL</code> to exclude ticarcillin. If a manually defined column does not exist in the data, it will be skipped with a warning.</p></dd>
@@ -155,7 +159,7 @@ Leclercq et al. <strong>EUCAST expert rules in antimicrobial susceptibility test
<dt id="arg-administration">administration<a class="anchor" aria-label="anchor" href="#arg-administration"></a></dt>
<dd><p>Route of administration, either .val , .val im, .val iv, .val oral, or NA.</p></dd>
<dd><p>Route of administration, either <code>""</code>, <code>"im"</code>, <code>"iv"</code>, <code>"oral"</code>, or NA.</p></dd>
</dl></div>
<div class="section level2">
@@ -229,9 +233,13 @@ Leclercq et al. <strong>EUCAST expert rules in antimicrobial susceptibility test
<span class="r-in"><span><span class="co"># apply EUCAST rules: some results wil be changed</span></span></span>
<span class="r-in"><span><span class="va">b</span> <span class="op">&lt;-</span> <span class="fu">eucast_rules</span><span class="op">(</span><span class="va">a</span>, overwrite <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span class="warning">Warning: </span>in `eucast_rules()`: not all columns with antimicrobial results are of class</span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">&lt;sir&gt;</span>. Transform them on beforehand, e.g.: - x <span style="color: #D7AF00;">%&gt;%</span> <span style="font-weight: bold;">as.sir</span><span style="color: #D7AF00;">(</span>CXM<span style="color: #D7AF00;">:</span>AMX<span style="color: #D7AF00;">)</span> - x <span style="color: #D7AF00;">%&gt;%</span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span style="font-weight: bold;">mutate_if</span><span style="color: #D7AF00;">(</span>is_sir_eligible, as.sir<span style="color: #D7AF00;">)</span> - x <span style="color: #D7AF00;">%&gt;%</span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span style="font-weight: bold;">mutate</span><span style="color: #D7AF00;">(</span><span style="font-weight: bold;">across</span><span style="color: #BBBB00;">(</span><span style="font-weight: bold;">where</span><span style="color: #0000BB;">(</span>is_sir_eligible<span style="color: #0000BB;">)</span>, as.sir<span style="color: #BBBB00;">)</span><span style="color: #D7AF00;">)</span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">&lt;sir&gt;</span>. Transform them on beforehand, e.g.:</span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> </span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> • x <span style="color: #D7AF00;">|&gt;</span> <span style="font-weight: bold;">as.sir</span><span style="color: #D7AF00;">(</span>CXM<span style="color: #D7AF00;">:</span>AMX<span style="color: #D7AF00;">)</span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> </span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> • x <span style="color: #D7AF00;">|&gt;</span> <span style="font-weight: bold;">mutate_if</span><span style="color: #D7AF00;">(</span>is_sir_eligible, as.sir<span style="color: #D7AF00;">)</span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> </span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> • x <span style="color: #D7AF00;">|&gt;</span> <span style="font-weight: bold;">mutate</span><span style="color: #D7AF00;">(</span><span style="font-weight: bold;">across</span><span style="color: #BBBB00;">(</span><span style="font-weight: bold;">where</span><span style="color: #0000BB;">(</span>is_sir_eligible<span style="color: #0000BB;">)</span>, as.sir<span style="color: #BBBB00;">)</span><span style="color: #D7AF00;">)</span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="va">b</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> mo VAN AMX COL CAZ CXM PEN FOX</span>
@@ -246,9 +254,13 @@ Leclercq et al. <strong>EUCAST expert rules in antimicrobial susceptibility test
<span class="r-in"><span><span class="co"># containing all details about the transformations:</span></span></span>
<span class="r-in"><span><span class="va">c</span> <span class="op">&lt;-</span> <span class="fu">eucast_rules</span><span class="op">(</span><span class="va">a</span>, overwrite <span class="op">=</span> <span class="cn">TRUE</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span class="warning">Warning: </span>in `eucast_rules()`: not all columns with antimicrobial results are of class</span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">&lt;sir&gt;</span>. Transform them on beforehand, e.g.: - x <span style="color: #D7AF00;">%&gt;%</span> <span style="font-weight: bold;">as.sir</span><span style="color: #D7AF00;">(</span>CXM<span style="color: #D7AF00;">:</span>AMX<span style="color: #D7AF00;">)</span> - x <span style="color: #D7AF00;">%&gt;%</span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span style="font-weight: bold;">mutate_if</span><span style="color: #D7AF00;">(</span>is_sir_eligible, as.sir<span style="color: #D7AF00;">)</span> - x <span style="color: #D7AF00;">%&gt;%</span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span style="font-weight: bold;">mutate</span><span style="color: #D7AF00;">(</span><span style="font-weight: bold;">across</span><span style="color: #BBBB00;">(</span><span style="font-weight: bold;">where</span><span style="color: #0000BB;">(</span>is_sir_eligible<span style="color: #0000BB;">)</span>, as.sir<span style="color: #BBBB00;">)</span><span style="color: #D7AF00;">)</span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">&lt;sir&gt;</span>. Transform them on beforehand, e.g.:</span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> </span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> • x <span style="color: #D7AF00;">|&gt;</span> <span style="font-weight: bold;">as.sir</span><span style="color: #D7AF00;">(</span>CXM<span style="color: #D7AF00;">:</span>AMX<span style="color: #D7AF00;">)</span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> </span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> • x <span style="color: #D7AF00;">|&gt;</span> <span style="font-weight: bold;">mutate_if</span><span style="color: #D7AF00;">(</span>is_sir_eligible, as.sir<span style="color: #D7AF00;">)</span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> </span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> • x <span style="color: #D7AF00;">|&gt;</span> <span style="font-weight: bold;">mutate</span><span style="color: #D7AF00;">(</span><span style="font-weight: bold;">across</span><span style="color: #BBBB00;">(</span><span style="font-weight: bold;">where</span><span style="color: #0000BB;">(</span>is_sir_eligible<span style="color: #0000BB;">)</span>, as.sir<span style="color: #BBBB00;">)</span><span style="color: #D7AF00;">)</span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="va">c</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> row col mo_fullname old new rule rule_group</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 1 1 AMX Staphylococcus aureus - S Breakpoints</span>

43
reference/interpretive_rules.md
View File

@@ -21,7 +21,7 @@ interpretive_rules(x, col_mo = NULL, info = interactive(),
verbose = FALSE, version_breakpoints = 16,
version_expected_phenotypes = 1.2, version_expertrules = 3.3,
ampc_cephalosporin_resistance = NA, only_sir_columns = any(is.sir(x)),
custom_rules = NULL, overwrite = FALSE, ...)
custom_rules = NULL, overwrite = FALSE, add_if_missing = TRUE, ...)
eucast_rules(x, col_mo = NULL, info = interactive(),
rules = getOption("AMR_interpretive_rules", default = c("breakpoints",
@@ -119,18 +119,18 @@ eucast_dosage(ab, administration = "iv", version_breakpoints = 15)
- version_breakpoints:
The version number to use for the EUCAST Clinical Breakpoints
guideline. Can be .val 16.0, .val 15.0, .val 14.0, .val 13.1, .val
12.0, .val 11.0, or .val 10.0.
guideline. Can be `"16.0"`, `"15.0"`, `"14.0"`, `"13.1"`, `"12.0"`,
`"11.0"`, or `"10.0"`.
- version_expected_phenotypes:
The version number to use for the EUCAST Expected Phenotypes. Can be
.val 1.2.
`"1.2"`.
- version_expertrules:
The version number to use for the EUCAST Expert Rules and Intrinsic
Resistance guideline. Can be .val 3.3, .val 3.2, or .val 3.1.
Resistance guideline. Can be `"3.3"`, `"3.2"`, or `"3.1"`.
- ampc_cephalosporin_resistance:
@@ -178,6 +178,16 @@ eucast_dosage(ab, administration = "iv", version_breakpoints = 15)
be tested for susceptibility to individual agents or be reported
resistant".
- add_if_missing:
A [logical](https://rdrr.io/r/base/logical.html) indicating whether
rules should also be applied to missing (`NA`) values (default:
`TRUE`). When `FALSE`, rules are only applied to cells that already
contain an SIR value; cells with `NA` are left untouched. This is
particularly useful when using `overwrite = TRUE` with custom rules
and you want to update reported results without imputing values for
untested drugs.
- ...:
Column names of antimicrobials. To automatically detect antimicrobial
@@ -197,8 +207,7 @@ eucast_dosage(ab, administration = "iv", version_breakpoints = 15)
- administration:
Route of administration, either .val , .val im, .val iv, .val oral, or
NA.
Route of administration, either `""`, `"im"`, `"iv"`, `"oral"`, or NA.
## Value
@@ -310,9 +319,13 @@ head(a)
# apply EUCAST rules: some results wil be changed
b <- eucast_rules(a, overwrite = TRUE)
#> Warning: in `eucast_rules()`: not all columns with antimicrobial results are of class
#> <sir>. Transform them on beforehand, e.g.: - x %>% as.sir(CXM:AMX) - x %>%
#> mutate_if(is_sir_eligible, as.sir) - x %>%
#> mutate(across(where(is_sir_eligible), as.sir))
#> <sir>. Transform them on beforehand, e.g.:
#>
#> • x |> as.sir(CXM:AMX)
#>
#> • x |> mutate_if(is_sir_eligible, as.sir)
#>
#> • x |> mutate(across(where(is_sir_eligible), as.sir))
head(b)
#> mo VAN AMX COL CAZ CXM PEN FOX
@@ -327,9 +340,13 @@ head(b)
# containing all details about the transformations:
c <- eucast_rules(a, overwrite = TRUE, verbose = TRUE)
#> Warning: in `eucast_rules()`: not all columns with antimicrobial results are of class
#> <sir>. Transform them on beforehand, e.g.: - x %>% as.sir(CXM:AMX) - x %>%
#> mutate_if(is_sir_eligible, as.sir) - x %>%
#> mutate(across(where(is_sir_eligible), as.sir))
#> <sir>. Transform them on beforehand, e.g.:
#>
#> • x |> as.sir(CXM:AMX)
#>
#> • x |> mutate_if(is_sir_eligible, as.sir)
#>
#> • x |> mutate(across(where(is_sir_eligible), as.sir))
head(c)
#> row col mo_fullname old new rule rule_group
#> 1 1 AMX Staphylococcus aureus - S Breakpoints

2
reference/intrinsic_resistant.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/italicise_taxonomy.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/join.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/key_antimicrobials.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/kurtosis.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/like.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/mdro.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/mean_amr_distance.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/microorganisms.codes.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/microorganisms.groups.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

8
reference/microorganisms.html
View File

@@ -9,7 +9,7 @@ This data set is carefully crafted, yet made 100% reproducible from public and a
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -65,12 +65,12 @@ This data set is carefully crafted, yet made 100% reproducible from public and a
<h2 id="format">Format<a class="anchor" aria-label="anchor" href="#format"></a></h2>
<p>A <a href="https://tibble.tidyverse.org/reference/tibble.html" class="external-link">tibble</a> with 78 679 observations and 26 variables:</p><ul><li><p><code>mo</code><br> ID of microorganism as used by this package. <em><strong>This is a unique identifier.</strong></em></p></li>
<li><p><code>fullname</code><br> Full name, like <code>"Escherichia coli"</code>. For the taxonomic ranks genus, species and subspecies, this is the 'pasted' text of genus, species, and subspecies. For all taxonomic ranks higher than genus, this is the name of the taxon. <em><strong>This is a unique identifier.</strong></em></p></li>
<li><p><code>status</code> <br> Status of the taxon, either .val accepted, .val not validly published, .val synonym, or .val unknown</p></li>
<li><p><code>status</code> <br> Status of the taxon, either <code>"accepted"</code>, <code>"not validly published"</code>, <code>"synonym"</code>, or <code>"unknown"</code></p></li>
<li><p><code>kingdom</code>, <code>phylum</code>, <code>class</code>, <code>order</code>, <code>family</code>, <code>genus</code>, <code>species</code>, <code>subspecies</code><br> Taxonomic rank of the microorganism. Note that for fungi, <em>phylum</em> is equal to their taxonomic <em>division</em>. Also, for fungi, <em>subkingdom</em> and <em>subdivision</em> were left out since they do not occur in the bacterial taxonomy.</p></li>
<li><p><code>rank</code><br> Text of the taxonomic rank of the microorganism, such as <code>"species"</code> or <code>"genus"</code></p></li>
<li><p><code>ref</code><br> Author(s) and year of related scientific publication. This contains only the <em>first surname</em> and year of the <em>latest</em> authors, e.g. "Wallis <em>et al.</em> 2006 <em>emend.</em> Smith and Jones 2018" becomes "Smith <em>et al.</em>, 2018". This field is directly retrieved from the source specified in the column <code>source</code>. Moreover, accents were removed to comply with CRAN that only allows ASCII characters.</p></li>
<li><p><code>oxygen_tolerance</code> <br> Oxygen tolerance, either .val aerobe, .val anaerobe, .val anaerobe/microaerophile, .val facultative anaerobe, .val likely facultative anaerobe, .val microaerophile, or NA. These data were retrieved from BacDive (see <em>Source</em>). Items that contain "likely" are missing from BacDive and were extrapolated from other species within the same genus to guess the oxygen tolerance. Currently 68.3% of all ~39 000 bacteria in the data set contain an oxygen tolerance.</p></li>
<li><p><code>source</code><br> Either .val GBIF, .val LPSN, .val Manually added, .val MycoBank, or .val manually added (see <em>Source</em>)</p></li>
<li><p><code>oxygen_tolerance</code> <br> Oxygen tolerance, either <code>"aerobe"</code>, <code>"anaerobe"</code>, <code>"anaerobe/microaerophile"</code>, <code>"facultative anaerobe"</code>, <code>"likely facultative anaerobe"</code>, <code>"microaerophile"</code>, or NA. These data were retrieved from BacDive (see <em>Source</em>). Items that contain "likely" are missing from BacDive and were extrapolated from other species within the same genus to guess the oxygen tolerance. Currently 68.3% of all ~39 000 bacteria in the data set contain an oxygen tolerance.</p></li>
<li><p><code>source</code><br> Either <code>"GBIF"</code>, <code>"LPSN"</code>, <code>"Manually added"</code>, <code>"MycoBank"</code>, or <code>"manually added"</code> (see <em>Source</em>)</p></li>
<li><p><code>lpsn</code><br> Identifier ('Record number') of List of Prokaryotic names with Standing in Nomenclature (LPSN). This will be the first/highest LPSN identifier to keep one identifier per row. For example, <em>Acetobacter ascendens</em> has LPSN Record number 7864 and 11011. Only the first is available in the <code>microorganisms</code> data set. <em><strong>This is a unique identifier</strong></em>, though available for only ~33 000 records.</p></li>
<li><p><code>lpsn_parent</code><br> LPSN identifier of the parent taxon</p></li>
<li><p><code>lpsn_renamed_to</code><br> LPSN identifier of the currently valid taxon</p></li>

23
reference/microorganisms.md
View File

@@ -36,8 +36,8 @@ A [tibble](https://tibble.tidyverse.org/reference/tibble.html) with 78
name of the taxon. ***This is a unique identifier.***
- `status`
Status of the taxon, either .val accepted, .val not validly published,
.val synonym, or .val unknown
Status of the taxon, either `"accepted"`, `"not validly published"`,
`"synonym"`, or `"unknown"`
- `kingdom`, `phylum`, `class`, `order`, `family`, `genus`, `species`,
`subspecies`
@@ -59,17 +59,18 @@ A [tibble](https://tibble.tidyverse.org/reference/tibble.html) with 78
comply with CRAN that only allows ASCII characters.
- `oxygen_tolerance`
Oxygen tolerance, either .val aerobe, .val anaerobe, .val
anaerobe/microaerophile, .val facultative anaerobe, .val likely
facultative anaerobe, .val microaerophile, or NA. These data were
retrieved from BacDive (see *Source*). Items that contain "likely" are
missing from BacDive and were extrapolated from other species within
the same genus to guess the oxygen tolerance. Currently 68.3% of all
~39 000 bacteria in the data set contain an oxygen tolerance.
Oxygen tolerance, either `"aerobe"`, `"anaerobe"`,
`"anaerobe/microaerophile"`, `"facultative anaerobe"`,
`"likely facultative anaerobe"`, `"microaerophile"`, or NA. These data
were retrieved from BacDive (see *Source*). Items that contain
"likely" are missing from BacDive and were extrapolated from other
species within the same genus to guess the oxygen tolerance. Currently
68.3% of all ~39 000 bacteria in the data set contain an oxygen
tolerance.
- `source`
Either .val GBIF, .val LPSN, .val Manually added, .val MycoBank, or
.val manually added (see *Source*)
Either `"GBIF"`, `"LPSN"`, `"Manually added"`, `"MycoBank"`, or
`"manually added"` (see *Source*)
- `lpsn`
Identifier ('Record number') of List of Prokaryotic names with

2
reference/mo_matching_score.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

4
reference/mo_property.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -196,7 +196,7 @@
<dt id="arg-property">property<a class="anchor" aria-label="anchor" href="#arg-property"></a></dt>
<dd><p>One of the column names of the <a href="microorganisms.html">microorganisms</a> data set: .val mo, .val fullname, .val status, .val kingdom, .val phylum, .val class, .val order, .val family, .val genus, .val species, .val subspecies, .val rank, .val ref, .val oxygen_tolerance, .val source, .val lpsn, .val lpsn_parent, .val lpsn_renamed_to, .val mycobank, .val mycobank_parent, .val mycobank_renamed_to, .val gbif, .val gbif_parent, .val gbif_renamed_to, .val prevalence, or .val snomed, or must be <code>"shortname"</code>.</p></dd>
<dd><p>One of the column names of the <a href="microorganisms.html">microorganisms</a> data set: <code>"mo"</code>, <code>"fullname"</code>, <code>"status"</code>, <code>"kingdom"</code>, <code>"phylum"</code>, <code>"class"</code>, <code>"order"</code>, <code>"family"</code>, <code>"genus"</code>, <code>"species"</code>, <code>"subspecies"</code>, <code>"rank"</code>, <code>"ref"</code>, <code>"oxygen_tolerance"</code>, <code>"source"</code>, <code>"lpsn"</code>, <code>"lpsn_parent"</code>, <code>"lpsn_renamed_to"</code>, <code>"mycobank"</code>, <code>"mycobank_parent"</code>, <code>"mycobank_renamed_to"</code>, <code>"gbif"</code>, <code>"gbif_parent"</code>, <code>"gbif_renamed_to"</code>, <code>"prevalence"</code>, or <code>"snomed"</code>, or must be <code>"shortname"</code>.</p></dd>
</dl></div>
<div class="section level2">

14
reference/mo_property.md
View File

@@ -174,13 +174,13 @@ mo_property(x, property = "fullname", language = get_AMR_locale(),
One of the column names of the
[microorganisms](https://amr-for-r.org/reference/microorganisms.md)
data set: .val mo, .val fullname, .val status, .val kingdom, .val
phylum, .val class, .val order, .val family, .val genus, .val species,
.val subspecies, .val rank, .val ref, .val oxygen_tolerance, .val
source, .val lpsn, .val lpsn_parent, .val lpsn_renamed_to, .val
mycobank, .val mycobank_parent, .val mycobank_renamed_to, .val gbif,
.val gbif_parent, .val gbif_renamed_to, .val prevalence, or .val
snomed, or must be `"shortname"`.
data set: `"mo"`, `"fullname"`, `"status"`, `"kingdom"`, `"phylum"`,
`"class"`, `"order"`, `"family"`, `"genus"`, `"species"`,
`"subspecies"`, `"rank"`, `"ref"`, `"oxygen_tolerance"`, `"source"`,
`"lpsn"`, `"lpsn_parent"`, `"lpsn_renamed_to"`, `"mycobank"`,
`"mycobank_parent"`, `"mycobank_renamed_to"`, `"gbif"`,
`"gbif_parent"`, `"gbif_renamed_to"`, `"prevalence"`, or `"snomed"`,
or must be `"shortname"`.
## Value

2
reference/mo_source.html
View File

@@ -9,7 +9,7 @@ This is the fastest way to have your organisation (or analysis) specific codes p
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/pca.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

4
reference/plot.html
View File

@@ -9,7 +9,7 @@ Especially the scale_*_mic() functions are relevant wrappers to plot MIC values
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -209,7 +209,7 @@ Especially the scale_*_mic() functions are relevant wrappers to plot MIC values
<dt id="arg-breakpoint-type">breakpoint_type<a class="anchor" aria-label="anchor" href="#arg-breakpoint-type"></a></dt>
<dd><p>The type of breakpoints to use, either .val ECOFF, .val animal, or .val human. ECOFF stands for Epidemiological Cut-Off values. The default is <code>"human"</code>, which can also be set with the package option <code><a href="AMR-options.html">AMR_breakpoint_type</a></code>. If <code>host</code> is set to values of veterinary species, this will automatically be set to <code>"animal"</code>.</p></dd>
<dd><p>The type of breakpoints to use, either <code>"ECOFF"</code>, <code>"animal"</code>, or <code>"human"</code>. ECOFF stands for Epidemiological Cut-Off values. The default is <code>"human"</code>, which can also be set with the package option <code><a href="AMR-options.html">AMR_breakpoint_type</a></code>. If <code>host</code> is set to values of veterinary species, this will automatically be set to <code>"animal"</code>.</p></dd>
<dt id="arg-facet">facet<a class="anchor" aria-label="anchor" href="#arg-facet"></a></dt>

4
reference/plot.md
View File

@@ -199,8 +199,8 @@ labels_sir_count(position = NULL, x = "antibiotic",
- breakpoint_type:
The type of breakpoints to use, either .val ECOFF, .val animal, or
.val human. ECOFF stands for Epidemiological Cut-Off values. The
The type of breakpoints to use, either `"ECOFF"`, `"animal"`, or
`"human"`. ECOFF stands for Epidemiological Cut-Off values. The
default is `"human"`, which can also be set with the package option
[`AMR_breakpoint_type`](https://amr-for-r.org/reference/AMR-options.md).
If `host` is set to values of veterinary species, this will

2
reference/proportion.html
View File

@@ -9,7 +9,7 @@ resistance() should be used to calculate resistance, susceptibility() should be
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/random.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/resistance_predict.html
View File

@@ -9,7 +9,7 @@ NOTE: These functions are deprecated and will be removed in a future version. Us
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

2
reference/skewness.html
View File

@@ -9,7 +9,7 @@ When negative ('left-skewed'): the left tail is longer; the mass of the distribu
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

4
reference/top_n_microorganisms.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@@ -72,7 +72,7 @@
<dt id="arg-property">property<a class="anchor" aria-label="anchor" href="#arg-property"></a></dt>
<dd><p>A character string indicating the microorganism property to use for filtering. Must be one of the column names of the <a href="microorganisms.html">microorganisms</a> data set: .val mo, .val fullname, .val status, .val kingdom, .val phylum, .val class, .val order, .val family, .val genus, .val species, .val subspecies, .val rank, .val ref, .val oxygen_tolerance, .val source, .val lpsn, .val lpsn_parent, .val lpsn_renamed_to, .val mycobank, .val mycobank_parent, .val mycobank_renamed_to, .val gbif, .val gbif_parent, .val gbif_renamed_to, .val prevalence, or .val snomed. If <code>NULL</code>, the raw values from <code>col_mo</code> will be used without transformation. When using <code>"species"</code> (default) or <code>"subpecies"</code>, the genus will be added to make sure each (sub)species still belongs to the right genus.</p></dd>
<dd><p>A character string indicating the microorganism property to use for filtering. Must be one of the column names of the <a href="microorganisms.html">microorganisms</a> data set: <code>"mo"</code>, <code>"fullname"</code>, <code>"status"</code>, <code>"kingdom"</code>, <code>"phylum"</code>, <code>"class"</code>, <code>"order"</code>, <code>"family"</code>, <code>"genus"</code>, <code>"species"</code>, <code>"subspecies"</code>, <code>"rank"</code>, <code>"ref"</code>, <code>"oxygen_tolerance"</code>, <code>"source"</code>, <code>"lpsn"</code>, <code>"lpsn_parent"</code>, <code>"lpsn_renamed_to"</code>, <code>"mycobank"</code>, <code>"mycobank_parent"</code>, <code>"mycobank_renamed_to"</code>, <code>"gbif"</code>, <code>"gbif_parent"</code>, <code>"gbif_renamed_to"</code>, <code>"prevalence"</code>, or <code>"snomed"</code>. If <code>NULL</code>, the raw values from <code>col_mo</code> will be used without transformation. When using <code>"species"</code> (default) or <code>"subpecies"</code>, the genus will be added to make sure each (sub)species still belongs to the right genus.</p></dd>
<dt id="arg-n-for-each">n_for_each<a class="anchor" aria-label="anchor" href="#arg-n-for-each"></a></dt>

14
reference/top_n_microorganisms.md
View File

@@ -29,13 +29,13 @@ top_n_microorganisms(x, n, property = "species", n_for_each = NULL,
A character string indicating the microorganism property to use for
filtering. Must be one of the column names of the
[microorganisms](https://amr-for-r.org/reference/microorganisms.md)
data set: .val mo, .val fullname, .val status, .val kingdom, .val
phylum, .val class, .val order, .val family, .val genus, .val species,
.val subspecies, .val rank, .val ref, .val oxygen_tolerance, .val
source, .val lpsn, .val lpsn_parent, .val lpsn_renamed_to, .val
mycobank, .val mycobank_parent, .val mycobank_renamed_to, .val gbif,
.val gbif_parent, .val gbif_renamed_to, .val prevalence, or .val
snomed. If `NULL`, the raw values from `col_mo` will be used without
data set: `"mo"`, `"fullname"`, `"status"`, `"kingdom"`, `"phylum"`,
`"class"`, `"order"`, `"family"`, `"genus"`, `"species"`,
`"subspecies"`, `"rank"`, `"ref"`, `"oxygen_tolerance"`, `"source"`,
`"lpsn"`, `"lpsn_parent"`, `"lpsn_renamed_to"`, `"mycobank"`,
`"mycobank_parent"`, `"mycobank_renamed_to"`, `"gbif"`,
`"gbif_parent"`, `"gbif_renamed_to"`, `"prevalence"`, or `"snomed"`.
If `NULL`, the raw values from `col_mo` will be used without
transformation. When using `"species"` (default) or `"subpecies"`, the
genus will be added to make sure each (sub)species still belongs to
the right genus.

2
reference/translate.html
View File

@@ -7,7 +7,7 @@
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9044</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">3.0.1.9045</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">