2020-09-18 16:05:53 +02:00
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< title > Calculate the matching score for microorganisms — mo_matching_score • 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" / >
<!-- jquery -->
< script src = "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity = "sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin = "anonymous" > < / script >
<!-- Bootstrap -->
< link href = "https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/flatly/bootstrap.min.css" rel = "stylesheet" crossorigin = "anonymous" / >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity = "sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin = "anonymous" > < / script >
<!-- bootstrap - toc -->
< link rel = "stylesheet" href = "../bootstrap-toc.css" >
< script src = "../bootstrap-toc.js" > < / script >
<!-- Font Awesome icons -->
< link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity = "sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin = "anonymous" / >
< link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity = "sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin = "anonymous" / >
<!-- clipboard.js -->
< script src = "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity = "sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin = "anonymous" > < / script >
<!-- headroom.js -->
< script src = "https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity = "sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin = "anonymous" > < / script >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity = "sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin = "anonymous" > < / script >
<!-- pkgdown -->
< link href = "../pkgdown.css" rel = "stylesheet" >
< script src = "../pkgdown.js" > < / script >
< link href = "../extra.css" rel = "stylesheet" >
< script src = "../extra.js" > < / script >
< meta property = "og:title" content = "Calculate the matching score for microorganisms — mo_matching_score" / >
< meta property = "og:description" content = "This helper function is used by as.mo() to determine the most probable match of taxonomic records, based on user input." / >
< meta property = "og:image" content = "https://msberends.github.io/AMR/logo.png" / >
<!-- mathjax -->
< script src = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity = "sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin = "anonymous" > < / script >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity = "sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin = "anonymous" > < / script >
<!-- [if lt IE 9]>
< script src = "https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js" > < / script >
< script src = "https://oss.maxcdn.com/respond/1.4.2/respond.min.js" > < / script >
<![endif]-->
< / head >
< body data-spy = "scroll" data-target = "#toc" >
< div class = "container template-reference-topic" >
< header >
< div class = "navbar navbar-default navbar-fixed-top" role = "navigation" >
< div class = "container" >
< div class = "navbar-header" >
< button type = "button" class = "navbar-toggle collapsed" data-toggle = "collapse" data-target = "#navbar" aria-expanded = "false" >
< span class = "sr-only" > Toggle navigation< / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< span class = "navbar-brand" >
< a class = "navbar-link" href = "../index.html" > AMR (for R)< / a >
2020-09-26 16:51:17 +02:00
< span class = "version label label-default" data-toggle = "tooltip" data-placement = "bottom" title = "Latest development version" > 1.3.0.9031< / span >
2020-09-18 16:05:53 +02:00
< / span >
< / div >
< div id = "navbar" class = "navbar-collapse collapse" >
< ul class = "nav navbar-nav" >
< li >
< a href = "../index.html" >
< span class = "fa fa-home" > < / span >
Home
< / a >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" role = "button" aria-expanded = "false" >
< span class = "fa fa-question-circle" > < / span >
How to
< span class = "caret" > < / span >
< / a >
< ul class = "dropdown-menu" role = "menu" >
< li >
< a href = "../articles/AMR.html" >
< span class = "fa fa-directions" > < / span >
Conduct AMR analysis
< / a >
< / li >
< li >
< a href = "../articles/resistance_predict.html" >
< span class = "fa fa-dice" > < / span >
Predict antimicrobial resistance
< / a >
< / li >
< li >
< a href = "../articles/datasets.html" >
< span class = "fa fa-database" > < / span >
Data sets for download / own use
< / a >
< / li >
< li >
< a href = "../articles/PCA.html" >
< span class = "fa fa-compress" > < / span >
Conduct principal component analysis for AMR
< / a >
< / li >
< li >
< a href = "../articles/MDR.html" >
< span class = "fa fa-skull-crossbones" > < / span >
Determine multi-drug resistance (MDR)
< / a >
< / li >
< li >
< a href = "../articles/WHONET.html" >
< span class = "fa fa-globe-americas" > < / span >
Work with WHONET data
< / a >
< / li >
< li >
< a href = "../articles/SPSS.html" >
< span class = "fa fa-file-upload" > < / span >
Import data from SPSS/SAS/Stata
< / a >
< / li >
< li >
< a href = "../articles/EUCAST.html" >
< span class = "fa fa-exchange-alt" > < / span >
Apply EUCAST rules
< / a >
< / li >
< li >
< a href = "../reference/mo_property.html" >
< span class = "fa fa-bug" > < / span >
Get properties of a microorganism
< / a >
< / li >
< li >
< a href = "../reference/ab_property.html" >
< span class = "fa fa-capsules" > < / span >
Get properties of an antibiotic
< / a >
< / li >
< li >
< a href = "../articles/benchmarks.html" >
< span class = "fa fa-shipping-fast" > < / span >
Other: benchmarks
< / a >
< / li >
< / ul >
< / li >
< li >
< a href = "../reference/index.html" >
< span class = "fa fa-book-open" > < / span >
Manual
< / a >
< / li >
< li >
< a href = "../authors.html" >
< span class = "fa fa-users" > < / span >
Authors
< / a >
< / li >
< li >
< a href = "../news/index.html" >
< span class = "far fa far fa-newspaper" > < / span >
Changelog
< / a >
< / li >
< / ul >
< ul class = "nav navbar-nav navbar-right" >
< li >
< a href = "https://github.com/msberends/AMR" >
< span class = "fab fa fab fa-github" > < / span >
Source Code
< / a >
< / li >
< li >
< a href = "../survey.html" >
< span class = "fa fa-clipboard-list" > < / span >
Survey
< / a >
< / li >
< / ul >
< / div > <!-- /.nav - collapse -->
< / div > <!-- /.container -->
< / div > <!-- /.navbar -->
< / header >
< div class = "row" >
< div class = "col-md-9 contents" >
< div class = "page-header" >
< h1 > Calculate the matching score for microorganisms< / h1 >
< small class = "dont-index" > Source: < a href = 'https://github.com/msberends/AMR/blob/master/R/mo_matching_score.R' > < code > R/mo_matching_score.R< / code > < / a > < / small >
< div class = "hidden name" > < code > mo_matching_score.Rd< / code > < / div >
< / div >
< div class = "ref-description" >
< p > This helper function is used by < code > < a href = 'as.mo.html' > as.mo()< / a > < / code > to determine the most probable match of taxonomic records, based on user input.< / p >
< / div >
2020-09-26 16:26:01 +02:00
< pre class = "usage" > < span class = 'fu' > mo_matching_score< / span > (< span class = 'kw' > x< / span > , < span class = 'kw' > n< / span > )< / pre >
2020-09-18 16:05:53 +02:00
< h2 class = "hasAnchor" id = "arguments" > < a class = "anchor" href = "#arguments" > < / a > Arguments< / h2 >
< table class = "ref-arguments" >
< colgroup > < col class = "name" / > < col class = "desc" / > < / colgroup >
< tr >
< th > x< / th >
< td > < p > Any user input value(s)< / p > < / td >
< / tr >
< tr >
2020-09-26 16:26:01 +02:00
< th > n< / th >
2020-09-18 16:05:53 +02:00
< td > < p > A full taxonomic name, that exists in < code > < a href = 'microorganisms.html' > microorganisms$fullname< / a > < / code > < / p > < / td >
< / tr >
< / table >
2020-09-26 16:26:01 +02:00
< h2 class = "hasAnchor" id = "matching-score-for-microorganisms" > < a class = "anchor" href = "#matching-score-for-microorganisms" > < / a > Matching score for microorganisms< / h2 >
2020-09-18 16:05:53 +02:00
2020-09-26 16:26:01 +02:00
2020-09-18 16:05:53 +02:00
2020-09-26 16:51:17 +02:00
< p > With ambiguous user input in < code > < a href = 'as.mo.html' > as.mo()< / a > < / code > and all the < code > < a href = 'mo_property.html' > mo_*< / a > < / code > functions, the returned results are chosen based on their matching score using < code > mo_matching_score()< / code > . This matching score \(m\), ranging from 0 to 100%, is calculated as:< / p >
< p > $$m_{(x, n)} = \frac{l_{n} - 0.5 \cdot \min \begin{cases}l_{n} \\ \operatorname{lev}(x, n)\end{cases}}{l_{n} \cdot p_{n} \cdot k_{n}}$$< / p >
2020-09-26 16:26:01 +02:00
< p > where:< / p > < ul >
< li > < p > \(x\) is the user input;< / p > < / li >
2020-09-26 16:51:17 +02:00
< li > < p > \(n\) is a taxonomic name (genus, species and subspecies) as found in < code > < a href = 'microorganisms.html' > microorganisms$fullname< / a > < / code > ;< / p > < / li >
< li > < p > \(l_{n}\) is the length of \(n\);< / p > < / li >
< li > < p > \(\operatorname{lev}\) is the < a href = 'https://en.wikipedia.org/wiki/Levenshtein_distance' > Levenshtein distance function< / a > ;< / p > < / li >
< li > < p > \(p_{n}\) is the human pathogenic prevalence of \(n\), categorised into group \(1\), \(2\) and \(3\) (see < em > Details< / em > in < code > < a href = 'as.mo.html' > ?as.mo< / a > < / code > ), meaning that \(p = \{1, 2 , 3\}\);< / p > < / li >
< li > < p > \(k_{n}\) is the kingdom index of \(n\), set as follows: Bacteria = \(1\), Fungi = \(2\), Protozoa = \(3\), Archaea = \(4\), and all others = \(5\), meaning that \(k = \{1, 2 , 3, 4, 5\}\).< / p > < / li >
2020-09-26 16:26:01 +02:00
< / ul >
2020-09-26 16:51:17 +02:00
< p > This means that the user input < code > x = "E. coli"< / code > gets for < em > Escherichia coli< / em > a matching score of 68.8% and for < em > Entamoeba coli< / em > a matching score of 7.9%.< / p >
2020-09-26 16:26:01 +02:00
< p > All matches are sorted descending on their matching score and for all user input values, the top match will be returned.< / p >
2020-09-18 16:05:53 +02:00
< h2 class = "hasAnchor" id = "examples" > < a class = "anchor" href = "#examples" > < / a > Examples< / h2 >
< pre class = "examples" > < span class = 'fu' > < a href = 'as.mo.html' > as.mo< / a > < / span > (< span class = 'st' > "E. coli"< / span > )
< span class = 'fu' > < a href = 'as.mo.html' > mo_uncertainties< / a > < / span > ()
2020-09-26 16:26:01 +02:00
< span class = 'fu' > mo_matching_score< / span > (< span class = 'st' > "E. coli"< / span > , < span class = 'st' > "Escherichia coli"< / span > )
2020-09-18 16:05:53 +02:00
< / pre >
< / div >
< div class = "col-md-3 hidden-xs hidden-sm" id = "pkgdown-sidebar" >
< nav id = "toc" data-toggle = "toc" class = "sticky-top" >
< h2 data-toc-skip > Contents< / h2 >
< / nav >
< / div >
< / div >
< footer >
< div class = "copyright" >
< p > Developed by < a href = 'https://www.rug.nl/staff/m.s.berends/' > Matthijs S. Berends< / a > , < a href = 'https://www.rug.nl/staff/c.f.luz/' > Christian F. Luz< / a > , < a href = 'https://www.rug.nl/staff/a.w.friedrich/' > Alexander W. Friedrich< / a > , < a href = 'https://www.rug.nl/staff/b.sinha/' > Bhanu N. M. Sinha< / a > , < a href = 'https://www.rug.nl/staff/c.j.albers/' > Casper J. Albers< / a > , < a href = 'https://www.rug.nl/staff/c.glasner/' > Corinna Glasner< / a > .< / p >
< / div >
< div class = "pkgdown" >
< p > Site built with < a href = "https://pkgdown.r-lib.org/" > pkgdown< / a > 1.5.1.9000.< / p >
< / div >
< / footer >
< / div >
< / body >
< / html >
