mirror of
https://github.com/msberends/AMR.git
synced 2025-07-27 11:07:53 +02:00
articles
deps
news
reference
figures
%like%.html
%like_case%.html
%unlike%.html
%unlike_case%.html
3MRGN.html
4MRGN.html
AMR-options.html
AMR-package.html
AMR.html
ATC.html
BRMO.html
EUCAST.html
MDR.html
NA_disk_.html
NA_mic_.html
NA_sir_.html
PDR.html
WHOCC.html
WHONET.html
XDR.html
ab.html
ab_atc.html
ab_atc_group1.html
ab_atc_group2.html
ab_cid.html
ab_class.html
ab_ddd.html
ab_ddd_units.html
ab_from_text.html
ab_group.html
ab_info.html
ab_loinc.html
ab_name.html
ab_property.html
ab_selector.html
ab_synonyms.html
ab_tradenames.html
ab_url.html
add_custom_antimicrobials.html
add_custom_microorganisms.html
administrable_iv.html
administrable_per_os.html
age.html
age_groups-1.png
age_groups.html
all_antimicrobials.html
aminoglycosides.html
aminopenicillins.html
amr_distance_from_row.html
anti_join_microorganisms.html
antibiogram-1.png
antibiogram-2.png
antibiogram-3.png
antibiogram-4.png
antibiogram.html
antibiotic_class_selectors.html
antibiotics.html
antifungals.html
antimicrobials_equal.html
antimycobacterials.html
antivirals.html
as.ab.html
as.av.html
as.disk.html
as.mic-1.png
as.mic-2.png
as.mic-3.png
as.mic-4.png
as.mic.html
as.mo.html
as.sir-1.png
as.sir-2.png
as.sir.data.frame.html
as.sir.default.html
as.sir.disk.html
as.sir.html
as.sir.mic.html
atc_online.html
atc_online_ddd.html
atc_online_ddd_units.html
atc_online_groups.html
autoplot.antibiogram.html
autoplot.disk.html
autoplot.mic.html
autoplot.resistance_predict.html
autoplot.sir.html
av.html
av_atc.html
av_cid.html
av_ddd.html
av_ddd_units.html
av_from_text.html
av_group.html
av_info.html
av_loinc.html
av_name.html
av_property.html
av_synonyms.html
av_tradenames.html
av_url.html
availability.html
betalactams.html
brmo.html
bug_drug_combinations.html
carbapenems.html
cephalosporins.html
cephalosporins_1st.html
cephalosporins_2nd.html
cephalosporins_3rd.html
cephalosporins_4th.html
cephalosporins_5th.html
clear_custom_antimicrobials.html
clear_custom_microorganisms.html
clinical_breakpoints.html
count.html
count_I.html
count_IR.html
count_R.html
count_S.html
count_SI.html
count_all.html
count_df.html
count_resistant.html
count_susceptible.html
custom_eucast_rules.html
custom_mdro_guideline.html
disk.html
dosage.html
droplevels.mic.html
eucast_dosage.html
eucast_exceptional_phenotypes.html
eucast_rules.html
example_isolates.html
example_isolates_unclean.html
export_ncbi_biosample.html
facet_sir.html
filter_first_isolate.html
first_isolate.html
fluoroquinolones.html
format.bug_drug_combinations.html
fortify.disk.html
fortify.mic.html
fortify.sir.html
full_join_microorganisms.html
g.test.html
geom_sir.html
get_AMR_locale.html
get_episode.html
get_mo_source.html
ggplot_pca-1.png
ggplot_pca-2.png
ggplot_pca.html
ggplot_sir-1.png
ggplot_sir-10.png
ggplot_sir-2.png
ggplot_sir-3.png
ggplot_sir-4.png
ggplot_sir-5.png
ggplot_sir-6.png
ggplot_sir-7.png
ggplot_sir-8.png
ggplot_sir-9.png
ggplot_sir.html
ggplot_sir_predict.html
glycopeptides.html
guess_ab_col.html
index.html
inner_join.html
inner_join_microorganisms.html
intrinsic_resistant.html
is.ab.html
is.av.html
is.disk.html
is.mic.html
is.mo.html
is.sir.html
is_new_episode.html
is_sir_eligible.html
italicise_taxonomy.html
italicize_taxonomy.html
join.html
key_antimicrobials.html
knit_print.antibiogram.html
kurtosis.data.frame.html
kurtosis.default.html
kurtosis.html
kurtosis.matrix.html
labels_sir_count.html
left_join_microorganisms.html
like.html
lincosamides.html
lipoglycopeptides.html
macrolides.html
mdr_cmi2012.html
mdr_tb.html
mdro.html
mean_amr_distance.data.frame.html
mean_amr_distance.html
mean_amr_distance.sir.html
mic.html
microorganisms.codes.html
microorganisms.groups.html
microorganisms.html
mo.html
mo_authors.html
mo_class.html
mo_cleaning_regex.html
mo_current.html
mo_domain.html
mo_failures.html
mo_family.html
mo_fullname.html
mo_gbif.html
mo_genus.html
mo_gramstain.html
mo_group_members.html
mo_info.html
mo_is_anaerobic.html
mo_is_gram_negative.html
mo_is_gram_positive.html
mo_is_intrinsic_resistant.html
mo_is_yeast.html
mo_kingdom.html
mo_lpsn.html
mo_matching_score.html
mo_mycobank.html
mo_name.html
mo_order.html
mo_oxygen_tolerance.html
mo_pathogenicity.html
mo_phylum.html
mo_property.html
mo_rank.html
mo_ref.html
mo_renamed.html
mo_reset_session.html
mo_shortname.html
mo_snomed.html
mo_source.html
mo_species.html
mo_status.html
mo_subspecies.html
mo_synonyms.html
mo_taxonomy.html
mo_type.html
mo_uncertainties.html
mo_url.html
mo_year.html
mrgn.html
n_sir.html
nitrofurans.html
not_intrinsic_resistant.html
oxazolidinones.html
pca-1.png
pca-2.png
pca.html
penicillins.html
plot-1.png
plot-10.png
plot-11.png
plot-12.png
plot-13.png
plot-14.png
plot-2.png
plot-3.png
plot-4.png
plot-5.png
plot-6.png
plot-7.png
plot-8.png
plot-9.png
plot.antibiogram.html
plot.disk.html
plot.html
plot.mic.html
plot.resistance_predict.html
plot.sir.html
polymyxins.html
portion.html
proportion.html
proportion_I.html
proportion_IR.html
proportion_R.html
proportion_S.html
proportion_SI.html
proportion_df.html
quinolones.html
random.html
random_disk.html
random_mic.html
random_sir.html
rescale_mic.html
reset_AMR_locale.html
resistance.html
resistance_predict-1.png
resistance_predict-2.png
resistance_predict-3.png
resistance_predict-4.png
resistance_predict.html
rifamycins.html
right_join_microorganisms.html
scale_colour_mic.html
scale_fill_mic.html
scale_sir_colours.html
scale_x_mic.html
scale_y_mic.html
scale_y_percent.html
semi_join_microorganisms.html
set_AMR_locale.html
set_ab_names.html
set_mo_source.html
sir.html
sir_confidence_interval.html
sir_df.html
sir_interpretation_history.html
sir_predict.html
skewness.data.frame.html
skewness.default.html
skewness.html
skewness.matrix.html
streptogramins.html
susceptibility.html
tetracyclines.html
theme_sir.html
translate.html
translate_AMR.html
trimethoprims.html
ureidopenicillins.html
.nojekyll
404.html
AMR_intro.png
AMR_intro.svg
AMRforRGPT.svg
LICENSE-text.html
apple-touch-icon-120x120.png
apple-touch-icon-152x152.png
apple-touch-icon-180x180.png
apple-touch-icon-60x60.png
apple-touch-icon-76x76.png
apple-touch-icon.png
authors.html
countries.png
countries_large.png
endorsement_clsi_eucast.jpg
extra.css
extra.js
favicon-16x16.png
favicon-32x32.png
favicon.ico
index.html
katex-auto.js
lang_cs.svg
lang_da.svg
lang_de.svg
lang_el.svg
lang_en.svg
lang_es.svg
lang_fi.svg
lang_fr.svg
lang_it.svg
lang_ja.svg
lang_nl.svg
lang_no.svg
lang_pl.svg
lang_pt.svg
lang_ro.svg
lang_ru.svg
lang_sv.svg
lang_tr.svg
lang_uk.svg
lang_zh.svg
lightswitch.js
link.svg
logo.svg
logo_certe.svg
logo_eh1h.png
logo_interreg.png
logo_python.svg
logo_rug.svg
logo_umcg.svg
pkgdown.js
pkgdown.yml
search.json
sitemap.xml
163 lines
21 KiB
HTML
163 lines
21 KiB
HTML
<!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>User-Defined Reference Data Set for Microorganisms — mo_source • 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.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.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="User-Defined Reference Data Set for Microorganisms — mo_source"><meta name="description" content="These functions can be used to predefine your own reference to be used in as.mo() and consequently all mo_* functions (such as mo_genus() and mo_gramstain()).
|
|
This is the fastest way to have your organisation (or analysis) specific codes picked up and translated by this package, since you don't have to bother about it again after setting it up once."><meta property="og:description" content="These functions can be used to predefine your own reference to be used in as.mo() and consequently all mo_* functions (such as mo_genus() and mo_gramstain()).
|
|
This is the fastest way to have your organisation (or analysis) specific codes picked up and translated by this package, since you don't have to bother about it again after setting it up once."><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.9087</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="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="active 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>User-Defined Reference Data Set for Microorganisms</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/R/mo_source.R" class="external-link"><code>R/mo_source.R</code></a></small>
|
|
<div class="d-none name"><code>mo_source.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description section level2">
|
|
<p>These functions can be used to predefine your own reference to be used in <code><a href="as.mo.html">as.mo()</a></code> and consequently all <code><a href="mo_property.html">mo_*</a></code> functions (such as <code><a href="mo_property.html">mo_genus()</a></code> and <code><a href="mo_property.html">mo_gramstain()</a></code>).</p>
|
|
<p>This is <strong>the fastest way</strong> to have your organisation (or analysis) specific codes picked up and translated by this package, since you don't have to bother about it again after setting it up once.</p>
|
|
</div>
|
|
|
|
<div class="section level2">
|
|
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">set_mo_source</span><span class="op">(</span></span>
|
|
<span> <span class="va">path</span>,</span>
|
|
<span> destination <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_mo_source"</span>, <span class="st">"~/mo_source.rds"</span><span class="op">)</span></span>
|
|
<span><span class="op">)</span></span>
|
|
<span></span>
|
|
<span><span class="fu">get_mo_source</span><span class="op">(</span>destination <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_mo_source"</span>, <span class="st">"~/mo_source.rds"</span><span class="op">)</span><span class="op">)</span></span></code></pre></div>
|
|
</div>
|
|
|
|
<div class="section level2">
|
|
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
|
|
|
|
|
<dl><dt id="arg-path">path<a class="anchor" aria-label="anchor" href="#arg-path"></a></dt>
|
|
<dd><p>location of your reference file, this can be any text file (comma-, tab- or pipe-separated) or an Excel file (see <em>Details</em>). Can also be <code>""</code>, <code>NULL</code> or <code>FALSE</code> to delete the reference file.</p></dd>
|
|
|
|
|
|
<dt id="arg-destination">destination<a class="anchor" aria-label="anchor" href="#arg-destination"></a></dt>
|
|
<dd><p>destination of the compressed data file - the default is the user's home directory.</p></dd>
|
|
|
|
</dl></div>
|
|
<div class="section level2">
|
|
<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
|
|
<p>The reference file can be a text file separated with commas (CSV) or tabs or pipes, an Excel file (either 'xls' or 'xlsx' format) or an <span style="R">R</span> object file (extension '.rds'). To use an Excel file, you will need to have the <code>readxl</code> package installed.</p>
|
|
<p><code>set_mo_source()</code> will check the file for validity: it must be a <a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a>, must have a column named <code>"mo"</code> which contains values from <code><a href="microorganisms.html">microorganisms$mo</a></code> or <code><a href="microorganisms.html">microorganisms$fullname</a></code> and must have a reference column with your own defined values. If all tests pass, <code>set_mo_source()</code> will read the file into <span style="R">R</span> and will ask to export it to <code>"~/mo_source.rds"</code>. The CRAN policy disallows packages to write to the file system, although '<em>exceptions may be allowed in interactive sessions if the package obtains confirmation from the user</em>'. For this reason, this function only works in interactive sessions so that the user can <strong>specifically confirm and allow</strong> that this file will be created. The destination of this file can be set with the <code>destination</code> argument and defaults to the user's home directory. It can also be set with the package option <code><a href="AMR-options.html">AMR_mo_source</a></code>, e.g. <code>options(AMR_mo_source = "my/location/file.rds")</code>.</p>
|
|
<p>The created compressed data file <code>"mo_source.rds"</code> will be used at default for MO determination (function <code><a href="as.mo.html">as.mo()</a></code> and consequently all <code>mo_*</code> functions like <code><a href="mo_property.html">mo_genus()</a></code> and <code><a href="mo_property.html">mo_gramstain()</a></code>). The location and timestamp of the original file will be saved as an <a href="https://rdrr.io/r/base/attributes.html" class="external-link">attribute</a> to the compressed data file.</p>
|
|
<p>The function <code>get_mo_source()</code> will return the data set by reading <code>"mo_source.rds"</code> with <code><a href="https://rdrr.io/r/base/readRDS.html" class="external-link">readRDS()</a></code>. If the original file has changed (by checking the location and timestamp of the original file), it will call <code>set_mo_source()</code> to update the data file automatically if used in an interactive session.</p>
|
|
<p>Reading an Excel file (<code>.xlsx</code>) with only one row has a size of 8-9 kB. The compressed file created with <code>set_mo_source()</code> will then have a size of 0.1 kB and can be read by <code>get_mo_source()</code> in only a couple of microseconds (millionths of a second).</p>
|
|
</div>
|
|
<div class="section level2">
|
|
<h2 id="how-to-setup">How to Setup<a class="anchor" aria-label="anchor" href="#how-to-setup"></a></h2>
|
|
|
|
|
|
|
|
<p>Imagine this data on a sheet of an Excel file. The first column contains the organisation specific codes, the second column contains valid taxonomic names:</p>
|
|
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a> <span class="sc">|</span> A <span class="sc">|</span> B <span class="sc">|</span></span>
|
|
<span id="cb1-2"><a href="#cb1-2" tabindex="-1"></a><span class="sc">--</span><span class="er">|</span><span class="sc">--------------------</span><span class="er">|</span><span class="sc">-----------------------</span><span class="er">|</span></span>
|
|
<span id="cb1-3"><a href="#cb1-3" tabindex="-1"></a><span class="dv">1</span> <span class="sc">|</span> Organisation XYZ <span class="sc">|</span> mo <span class="sc">|</span></span>
|
|
<span id="cb1-4"><a href="#cb1-4" tabindex="-1"></a><span class="dv">2</span> <span class="sc">|</span> lab_mo_ecoli <span class="sc">|</span> Escherichia coli <span class="sc">|</span></span>
|
|
<span id="cb1-5"><a href="#cb1-5" tabindex="-1"></a><span class="dv">3</span> <span class="sc">|</span> lab_mo_kpneumoniae <span class="sc">|</span> Klebsiella pneumoniae <span class="sc">|</span></span>
|
|
<span id="cb1-6"><a href="#cb1-6" tabindex="-1"></a><span class="dv">4</span> <span class="sc">|</span> <span class="er">|</span> <span class="er">|</span></span></code></pre><p></p></div>
|
|
<p>We save it as <code>"home/me/ourcodes.xlsx"</code>. Now we have to set it as a source:</p>
|
|
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a><span class="fu">set_mo_source</span>(<span class="st">"home/me/ourcodes.xlsx"</span>)</span>
|
|
<span id="cb1-2"><a href="#cb1-2" tabindex="-1"></a><span class="co">#> </span><span class="al">NOTE</span><span class="co">: Created mo_source file '/Users/me/mo_source.rds' (0.3 kB) from</span></span>
|
|
<span id="cb1-3"><a href="#cb1-3" tabindex="-1"></a><span class="co">#> '/Users/me/Documents/ourcodes.xlsx' (9 kB), columns</span></span>
|
|
<span id="cb1-4"><a href="#cb1-4" tabindex="-1"></a><span class="co">#> "Organisation XYZ" and "mo"</span></span></code></pre><p></p></div>
|
|
<p>It has now created a file <code>"~/mo_source.rds"</code> with the contents of our Excel file. Only the first column with foreign values and the 'mo' column will be kept when creating the RDS file.</p>
|
|
<p>And now we can use it in our functions:</p>
|
|
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a><span class="fu">as.mo</span>(<span class="st">"lab_mo_ecoli"</span>)</span>
|
|
<span id="cb1-2"><a href="#cb1-2" tabindex="-1"></a><span class="co">#> Class 'mo'</span></span>
|
|
<span id="cb1-3"><a href="#cb1-3" tabindex="-1"></a><span class="co">#> [1] B_ESCHR_COLI</span></span>
|
|
<span id="cb1-4"><a href="#cb1-4" tabindex="-1"></a></span>
|
|
<span id="cb1-5"><a href="#cb1-5" tabindex="-1"></a><span class="fu">mo_genus</span>(<span class="st">"lab_mo_kpneumoniae"</span>)</span>
|
|
<span id="cb1-6"><a href="#cb1-6" tabindex="-1"></a><span class="co">#> [1] "Klebsiella"</span></span>
|
|
<span id="cb1-7"><a href="#cb1-7" tabindex="-1"></a></span>
|
|
<span id="cb1-8"><a href="#cb1-8" tabindex="-1"></a><span class="co"># other input values still work too</span></span>
|
|
<span id="cb1-9"><a href="#cb1-9" tabindex="-1"></a><span class="fu">as.mo</span>(<span class="fu">c</span>(<span class="st">"Escherichia coli"</span>, <span class="st">"E. coli"</span>, <span class="st">"lab_mo_ecoli"</span>))</span>
|
|
<span id="cb1-10"><a href="#cb1-10" tabindex="-1"></a><span class="co">#> </span><span class="al">NOTE</span><span class="co">: Translation to one microorganism was guessed with uncertainty.</span></span>
|
|
<span id="cb1-11"><a href="#cb1-11" tabindex="-1"></a><span class="co">#> Use mo_uncertainties() to review it.</span></span>
|
|
<span id="cb1-12"><a href="#cb1-12" tabindex="-1"></a><span class="co">#> Class 'mo'</span></span>
|
|
<span id="cb1-13"><a href="#cb1-13" tabindex="-1"></a><span class="co">#> [1] B_ESCHR_COLI B_ESCHR_COLI B_ESCHR_COLI</span></span></code></pre><p></p></div>
|
|
<p>If we edit the Excel file by, let's say, adding row 4 like this:</p>
|
|
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a> <span class="sc">|</span> A <span class="sc">|</span> B <span class="sc">|</span></span>
|
|
<span id="cb1-2"><a href="#cb1-2" tabindex="-1"></a><span class="sc">--</span><span class="er">|</span><span class="sc">--------------------</span><span class="er">|</span><span class="sc">-----------------------</span><span class="er">|</span></span>
|
|
<span id="cb1-3"><a href="#cb1-3" tabindex="-1"></a><span class="dv">1</span> <span class="sc">|</span> Organisation XYZ <span class="sc">|</span> mo <span class="sc">|</span></span>
|
|
<span id="cb1-4"><a href="#cb1-4" tabindex="-1"></a><span class="dv">2</span> <span class="sc">|</span> lab_mo_ecoli <span class="sc">|</span> Escherichia coli <span class="sc">|</span></span>
|
|
<span id="cb1-5"><a href="#cb1-5" tabindex="-1"></a><span class="dv">3</span> <span class="sc">|</span> lab_mo_kpneumoniae <span class="sc">|</span> Klebsiella pneumoniae <span class="sc">|</span></span>
|
|
<span id="cb1-6"><a href="#cb1-6" tabindex="-1"></a><span class="dv">4</span> <span class="sc">|</span> lab_Staph_aureus <span class="sc">|</span> Staphylococcus aureus <span class="sc">|</span></span>
|
|
<span id="cb1-7"><a href="#cb1-7" tabindex="-1"></a><span class="dv">5</span> <span class="sc">|</span> <span class="er">|</span> <span class="er">|</span></span></code></pre><p></p></div>
|
|
<p>...any new usage of an MO function in this package will update your data file:</p>
|
|
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a><span class="fu">as.mo</span>(<span class="st">"lab_mo_ecoli"</span>)</span>
|
|
<span id="cb1-2"><a href="#cb1-2" tabindex="-1"></a><span class="co">#> </span><span class="al">NOTE</span><span class="co">: Updated mo_source file '/Users/me/mo_source.rds' (0.3 kB) from</span></span>
|
|
<span id="cb1-3"><a href="#cb1-3" tabindex="-1"></a><span class="co">#> '/Users/me/Documents/ourcodes.xlsx' (9 kB), columns</span></span>
|
|
<span id="cb1-4"><a href="#cb1-4" tabindex="-1"></a><span class="co">#> "Organisation XYZ" and "mo"</span></span>
|
|
<span id="cb1-5"><a href="#cb1-5" tabindex="-1"></a><span class="co">#> Class 'mo'</span></span>
|
|
<span id="cb1-6"><a href="#cb1-6" tabindex="-1"></a><span class="co">#> [1] B_ESCHR_COLI</span></span>
|
|
<span id="cb1-7"><a href="#cb1-7" tabindex="-1"></a></span>
|
|
<span id="cb1-8"><a href="#cb1-8" tabindex="-1"></a><span class="fu">mo_genus</span>(<span class="st">"lab_Staph_aureus"</span>)</span>
|
|
<span id="cb1-9"><a href="#cb1-9" tabindex="-1"></a><span class="co">#> [1] "Staphylococcus"</span></span></code></pre><p></p></div>
|
|
<p>To delete the reference data file, just use <code>""</code>, <code>NULL</code> or <code>FALSE</code> as input for <code>set_mo_source()</code>:</p>
|
|
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a><span class="fu">set_mo_source</span>(<span class="cn">NULL</span>)</span>
|
|
<span id="cb1-2"><a href="#cb1-2" tabindex="-1"></a><span class="co">#> Removed mo_source file '/Users/me/mo_source.rds'</span></span></code></pre><p></p></div>
|
|
<p>If the original file (in the previous case an Excel file) is moved or deleted, the <code>mo_source.rds</code> file will be removed upon the next use of <code><a href="as.mo.html">as.mo()</a></code> or any <code><a href="mo_property.html">mo_*</a></code> function.</p>
|
|
</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>
|
|
|