P281424/AMR
1
0
Fork 0
mirror of https://github.com/msberends/AMR.git synced 2024-12-26 05:26:13 +01:00
Code Releases Activity
4c4a60b950
AMR/reference/AMR-options.html
github-actions 4c4a60b950 Built site for AMR@2.1.1.9103: 87271d2
2024-11-21 09:17:08 +00:00

115 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Options for the AMR package — AMR-options • AMR (for R)</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/Lato-0.4.9/font.css" rel="stylesheet"><link href="../deps/Fira_Code-0.4.9/font.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><script src="../extra.js"></script><meta property="og:title" content="Options for the AMR package — AMR-options"><meta name="description" content="This is an overview of all the package-specific options() you can set in the AMR package."><meta property="og:description" content="This is an overview of all the package-specific options() you can set in the AMR package."><meta property="og:image" content="https://msberends.github.io/AMR/logo.svg"></head><body>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
<nav class="navbar navbar-expand-lg fixed-top bg-primary" data-bs-theme="dark" aria-label="Site navigation"><div class="container">
<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="">2.1.1.9103</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">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar" class="collapse navbar-collapse ms-3">
<ul class="navbar-nav me-auto"><li class="active nav-item dropdown">
<button class="nav-link dropdown-toggle" type="button" id="dropdown-how-to" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true"><span class="fa fa-question-circle"></span> How to</button>
<ul class="dropdown-menu" aria-labelledby="dropdown-how-to"><li><a class="dropdown-item" href="../articles/AMR.html"><span class="fa fa-directions"></span> Conduct AMR Analysis</a></li>
<li><a class="dropdown-item" href="../reference/antibiogram.html"><span class="fa fa-file-prescription"></span> Generate Antibiogram (Trad./Syndromic/WISCA)</a></li>
<li><a class="dropdown-item" href="../articles/resistance_predict.html"><span class="fa fa-dice"></span> Predict Antimicrobial Resistance</a></li>
<li><a class="dropdown-item" href="../articles/datasets.html"><span class="fa fa-database"></span> Download Data Sets for Own Use</a></li>
<li><a class="dropdown-item" href="../reference/AMR-options.html"><span class="fa fa-gear"></span> Set User- Or Team-specific Package Settings</a></li>
<li><a class="dropdown-item" href="../articles/PCA.html"><span class="fa fa-compress"></span> Conduct Principal Component Analysis for AMR</a></li>
<li><a class="dropdown-item" href="../articles/MDR.html"><span class="fa fa-skull-crossbones"></span> Determine Multi-Drug Resistance (MDR)</a></li>
<li><a class="dropdown-item" href="../articles/WHONET.html"><span class="fa fa-globe-americas"></span> Work with WHONET Data</a></li>
<li><a class="dropdown-item" href="../articles/EUCAST.html"><span class="fa fa-exchange-alt"></span> Apply Eucast Rules</a></li>
<li><a class="dropdown-item" href="../reference/mo_property.html"><span class="fa fa-bug"></span> Get Taxonomy of a Microorganism</a></li>
<li><a class="dropdown-item" href="../reference/ab_property.html"><span class="fa fa-capsules"></span> Get Properties of an Antibiotic Drug</a></li>
<li><a class="dropdown-item" href="../reference/av_property.html"><span class="fa fa-capsules"></span> Get Properties of an Antiviral Drug</a></li>
</ul></li>
<li class="nav-item"><a class="nav-link" href="../articles/AMR_for_Python.html"><span class="fa fab fa-python"></span> AMR for Python</a></li>
<li class="nav-item"><a class="nav-link" href="../reference/index.html"><span class="fa fa-book-open"></span> Manual</a></li>
<li class="nav-item"><a class="nav-link" href="../authors.html"><span class="fa fa-users"></span> Authors</a></li>
</ul><ul class="navbar-nav"><li class="nav-item"><a class="nav-link" href="../news/index.html"><span class="fa far fa-newspaper"></span> Changelog</a></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/msberends/AMR"><span class="fa fab fa-github"></span> Source Code</a></li>
</ul></div>
</div>
</nav><div class="container template-reference-topic">
<div class="row">
<main id="main" class="col-md-9"><div class="page-header">
<img src="../logo.svg" class="logo" alt=""><h1>Options for the AMR package</h1>
<small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/R/aa_options.R" class="external-link"><code>R/aa_options.R</code></a></small>
<div class="d-none name"><code>AMR-options.Rd</code></div>
</div>
<div class="ref-description section level2">
<p>This is an overview of all the package-specific <code><a href="https://rdrr.io/r/base/options.html" class="external-link">options()</a></code> you can set in the <code>AMR</code> package.</p>
</div>
<div class="section level2">
<h2 id="options">Options<a class="anchor" aria-label="anchor" href="#options"></a></h2>
<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-12) 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 "ECOFF", "animal", or "human".</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>
<li><p><code>AMR_custom_mo</code> <br> A file location to an RDS file, to use custom microorganisms with this package. This is explained in <code><a href="add_custom_microorganisms.html">add_custom_microorganisms()</a></code>.</p></li>
<li><p><code>AMR_eucastrules</code> <br> A <a href="https://rdrr.io/r/base/character.html" class="external-link">character</a> to set the default types of rules for <code><a href="eucast_rules.html">eucast_rules()</a></code> function, must be one or more of: <code>"breakpoints"</code>, <code>"expert"</code>, <code>"other"</code>, <code>"custom"</code>, <code>"all"</code>, and defaults to <code>c("breakpoints", "expert")</code>.</p></li>
<li><p><code>AMR_guideline</code> <br> A <a href="https://rdrr.io/r/base/character.html" class="external-link">character</a> to set the default guideline for interpreting MIC values and disk diffusion diameters with <code><a href="as.sir.html">as.sir()</a></code>. Can be only the guideline name (e.g., <code>"CLSI"</code>) or the name with a year (e.g. <code>"CLSI 2019"</code>). The default to the latest implemented EUCAST guideline, currently <code>"EUCAST 2024"</code>. Supported guideline are currently EUCAST (2011-2024) and CLSI (2011-2024).</p></li>
<li><p><code>AMR_ignore_pattern</code> <br> A <a href="https://rdrr.io/r/base/regex.html" class="external-link">regular expression</a> to ignore (i.e., make <code>NA</code>) any match given in <code><a href="as.mo.html">as.mo()</a></code> and all <code><a href="mo_property.html">mo_*</a></code> functions.</p></li>
<li><p><code>AMR_include_PKPD</code> <br> A <a href="https://rdrr.io/r/base/logical.html" class="external-link">logical</a> to use in <code><a href="as.sir.html">as.sir()</a></code>, to indicate that PK/PD clinical breakpoints must be applied as a last resort - the default is <code>TRUE</code>.</p></li>
<li><p><code>AMR_include_screening</code> <br> A <a href="https://rdrr.io/r/base/logical.html" class="external-link">logical</a> to use in <code><a href="as.sir.html">as.sir()</a></code>, to indicate that clinical breakpoints for screening are allowed - the default is <code>FALSE</code>.</p></li>
<li><p><code>AMR_keep_synonyms</code> <br> A <a href="https://rdrr.io/r/base/logical.html" class="external-link">logical</a> 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 indicate if old, previously valid taxonomic names must be preserved and not be corrected to currently accepted names. The default is <code>FALSE</code>.</p></li>
<li><p><code>AMR_locale</code> <br> A <a href="https://rdrr.io/r/base/character.html" class="external-link">character</a> to set the language for the <code>AMR</code> package, can be one of these supported language names or ISO-639-1 codes: English (en), Chinese (zh), Czech (cs), Danish (da), Dutch (nl), Finnish (fi), French (fr), German (de), Greek (el), Italian (it), Japanese (ja), Norwegian (no), Polish (pl), Portuguese (pt), Romanian (ro), Russian (ru), Spanish (es), Swedish (sv), Turkish (tr), or Ukrainian (uk). The default is the current system language (if supported, English otherwise).</p></li>
<li><p><code>AMR_mo_source</code> <br> A file location for a manual code list to be used in <code><a href="as.mo.html">as.mo()</a></code> and all <code><a href="mo_property.html">mo_*</a></code> functions. This is explained in <code><a href="mo_source.html">set_mo_source()</a></code>.</p></li>
</ul></div>
<div class="section level2">
<h2 id="saving-settings-between-sessions">Saving Settings Between Sessions<a class="anchor" aria-label="anchor" href="#saving-settings-between-sessions"></a></h2>
<p>Settings in <span style="R">R</span> are not saved globally and are thus lost when <span style="R">R</span> is exited. You can save your options to your own <code>.Rprofile</code> file, which is a user-specific file. You can edit it using:</p>
<p></p><div class="sourceCode r"><pre><code><span> <span class="fu">utils</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/r/utils/file.edit.html" class="external-link">file.edit</a></span><span class="op">(</span><span class="st">"~/.Rprofile"</span><span class="op">)</span></span></code></pre><p></p></div>
<p>In this file, you can set options such as...</p>
<p></p><div class="sourceCode r"><pre><code><span> <span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">options</a></span><span class="op">(</span>AMR_locale <span class="op">=</span> <span class="st">"pt"</span><span class="op">)</span></span>
<span> <span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">options</a></span><span class="op">(</span>AMR_include_PKPD <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></code></pre><p></p></div>
<p>...to add Portuguese language support of antibiotics, and allow PK/PD rules when interpreting MIC values with <code><a href="as.sir.html">as.sir()</a></code>.</p><div class="section">
<h3 id="share-options-within-team">Share Options Within Team<a class="anchor" aria-label="anchor" href="#share-options-within-team"></a></h3>
<p>For a more global approach, e.g. within a (data) team, save an options file to a remote file location, such as a shared network drive, and have each user read in this file automatically at start-up. This would work in this way:</p><ol><li><p>Save a plain text file to e.g. "X:/team_folder/R_options.R" and fill it with preferred settings.</p></li>
<li><p>For each user, open the <code>.Rprofile</code> file using <code>utils::file.edit("~/.Rprofile")</code> and put in there:</p>
<p></p><div class="sourceCode r"><pre><code><span> <span class="kw"><a href="https://rdrr.io/r/base/source.html" class="external-link">source</a></span><span class="op">(</span><span class="st">"X:/team_folder/R_options.R"</span><span class="op">)</span></span></code></pre><p></p></div></li>
<li><p>Reload R/RStudio and check the settings with <code><a href="https://rdrr.io/r/base/options.html" class="external-link">getOption()</a></code>, e.g. <code>getOption("AMR_locale")</code> if you have set that value.</p></li>
</ol><p>Now the team settings are configured in only one place, and can be maintained there.</p>
</div>
</div>
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
</nav></aside></div>
<footer><div class="pkgdown-footer-left">
<p><code>AMR</code> (for R). Free and open-source, licenced under the <a target="_blank" href="https://github.com/msberends/AMR/blob/main/LICENSE" class="external-link">GNU General Public License version 2.0 (GPL-2)</a>.<br>Developed at the <a target="_blank" href="https://www.rug.nl" class="external-link">University of Groningen</a> and <a target="_blank" href="https://www.umcg.nl" class="external-link">University Medical Center Groningen</a> in The Netherlands.</p>
</div>
<div class="pkgdown-footer-right">
<p><a target="_blank" href="https://www.rug.nl" class="external-link"><img src="https://github.com/msberends/AMR/raw/main/pkgdown/assets/logo_rug.svg" style="max-width: 150px;"></a><a target="_blank" href="https://www.umcg.nl" class="external-link"><img src="https://github.com/msberends/AMR/raw/main/pkgdown/assets/logo_umcg.svg" style="max-width: 150px;"></a></p>
</div>
</footer></div>
</body></html>
View Git Blame Copy Permalink