2019-05-10 16:44:59 +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 > Transform to antibiotic ID — as.ab • 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" / >
2019-10-04 15:36:12 +02:00
2019-05-10 16:44:59 +02:00
<!-- jquery -->
2020-04-13 21:09:56 +02:00
< script src = "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity = "sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin = "anonymous" > < / script >
2019-05-10 16:44:59 +02:00
<!-- Bootstrap -->
2020-04-13 21:09:56 +02:00
< link href = "https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/flatly/bootstrap.min.css" rel = "stylesheet" crossorigin = "anonymous" / >
2019-05-10 16:44:59 +02:00
2019-10-04 15:36:12 +02:00
2020-04-13 21:09:56 +02:00
< 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 >
2019-05-10 16:44:59 +02:00
2020-04-17 19:16:30 +02:00
<!-- bootstrap - toc -->
< link rel = "stylesheet" href = "../bootstrap-toc.css" >
< script src = "../bootstrap-toc.js" > < / script >
2019-05-10 16:44:59 +02:00
<!-- Font Awesome icons -->
2020-04-17 19:16:30 +02:00
< 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" / >
2019-05-10 16:44:59 +02:00
<!-- clipboard.js -->
2020-04-17 19:16:30 +02:00
< script src = "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity = "sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin = "anonymous" > < / script >
2019-05-10 16:44:59 +02:00
2019-10-04 15:36:12 +02:00
<!-- headroom.js -->
2020-04-17 19:16:30 +02:00
< 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 >
2019-05-10 16:44:59 +02:00
<!-- pkgdown -->
< link href = "../pkgdown.css" rel = "stylesheet" >
< script src = "../pkgdown.js" > < / script >
< link href = "../extra.css" rel = "stylesheet" >
< script src = "../extra.js" > < / script >
2019-10-04 15:36:12 +02:00
< meta property = "og:title" content = "Transform to antibiotic ID — as.ab" / >
2019-05-10 16:44:59 +02:00
< meta property = "og:description" content = "Use this function to determine the antibiotic code of one or more antibiotics. The data set antibiotics will be searched for abbreviations, official names and synonyms (brand names)." / >
2020-04-17 19:16:30 +02:00
< meta property = "og:image" content = "https://msberends.gitlab.io/AMR/logo.svg" / >
2019-05-10 16:44:59 +02:00
2019-10-04 15:36:12 +02:00
2019-05-10 16:44:59 +02:00
<!-- 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]-->
2019-10-04 15:36:12 +02:00
2019-05-10 16:44:59 +02:00
< / head >
2020-04-17 19:16:30 +02:00
< body data-spy = "scroll" data-target = "#toc" >
2019-05-10 16:44:59 +02:00
< 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-04-17 19:16:30 +02:00
< span class = "version label label-default" data-toggle = "tooltip" data-placement = "bottom" title = "Latest development version" > 1.1.0< / span >
2019-05-10 16:44:59 +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 >
2020-04-13 21:09:56 +02:00
< li >
< a href = "../articles/PCA.html" >
< span class = "fa fa-compress" > < / span >
Conduct principal component analysis for AMR
< / a >
< / li >
2019-05-23 19:39:07 +02:00
< li >
< a href = "../articles/MDR.html" >
< span class = "fa fa-skull-crossbones" > < / span >
Determine multi-drug resistance (MDR)
< / a >
< / li >
2019-05-10 16:44:59 +02:00
< 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/" >
< 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/" >
< span class = "far fa far fa-newspaper" > < / span >
Changelog
< / a >
< / li >
< / ul >
< ul class = "nav navbar-nav navbar-right" >
< li >
< a href = "https://gitlab.com/msberends/AMR" >
< span class = "fab fa fab fa-gitlab" > < / span >
Source Code
< / a >
< / li >
< li >
< a href = "../LICENSE-text.html" >
< span class = "fa fa-book" > < / span >
Licence
< / a >
< / li >
< / ul >
< / div > <!-- /.nav - collapse -->
< / div > <!-- /.container -->
< / div > <!-- /.navbar -->
2019-10-04 15:36:12 +02:00
2019-05-10 16:44:59 +02:00
< / header >
< div class = "row" >
< div class = "col-md-9 contents" >
< div class = "page-header" >
< h1 > Transform to antibiotic ID< / h1 >
2020-04-17 19:16:30 +02:00
< small class = "dont-index" > Source: < a href = 'https://gitlab.com/msberends/AMR/blob/master/R/ab.R' > < code > R/ab.R< / code > < / a > < / small >
2019-05-10 16:44:59 +02:00
< div class = "hidden name" > < code > as.ab.Rd< / code > < / div >
< / div >
< div class = "ref-description" >
2019-11-28 22:32:17 +01:00
< p > Use this function to determine the antibiotic code of one or more antibiotics. The data set < a href = 'antibiotics.html' > antibiotics< / a > will be searched for abbreviations, official names and synonyms (brand names).< / p >
2019-05-10 16:44:59 +02:00
< / div >
2019-10-04 15:36:12 +02:00
< pre class = "usage" > < span class = 'fu' > as.ab< / span > (< span class = 'no' > x< / span > , < span class = 'no' > ...< / span > )
2019-05-16 21:20:00 +02:00
< span class = 'fu' > is.ab< / span > (< span class = 'no' > x< / span > )< / pre >
2019-10-04 15:36:12 +02:00
2019-05-10 16:44:59 +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 > character vector to determine to antibiotic ID< / p > < / td >
< / tr >
2019-10-04 15:36:12 +02:00
< tr >
< th > ...< / th >
< td > < p > arguments passed on to internal functions< / p > < / td >
< / tr >
2019-05-10 16:44:59 +02:00
< / table >
2019-10-04 15:36:12 +02:00
2019-05-10 16:44:59 +02:00
< h2 class = "hasAnchor" id = "value" > < a class = "anchor" href = "#value" > < / a > Value< / h2 >
2019-11-28 22:32:17 +01:00
< p > Character (vector) with class < code > ab< / code > . Unknown values will return < code > NA< / code > .< / p >
2019-05-10 16:44:59 +02:00
< h2 class = "hasAnchor" id = "details" > < a class = "anchor" href = "#details" > < / a > Details< / h2 >
2019-11-28 22:32:17 +01:00
< p > All entries in the < a href = 'antibiotics.html' > antibiotics< / a > data set have three different identifiers: a human readable EARS-Net code (column < code > ab< / code > , used by ECDC and WHONET), an ATC code (column < code > atc< / code > , used by WHO), and a CID code (column < code > cid< / code > , Compound ID, used by PubChem). The data set contains more than 5,000 official brand names from many different countries, as found in PubChem.< / p >
< p > Use the < code > < a href = 'ab_property.html' > ab_property()< / a > < / code > functions to get properties based on the returned antibiotic ID, see Examples.< / p >
2019-05-10 16:44:59 +02:00
< h2 class = "hasAnchor" id = "source" > < a class = "anchor" href = "#source" > < / a > Source< / h2 >
2019-10-04 15:36:12 +02:00
< p > World Health Organization (WHO) Collaborating Centre for Drug Statistics Methodology: < a href = 'https://www.whocc.no/atc_ddd_index/' > https://www.whocc.no/atc_ddd_index/< / a > < / p >
2019-05-10 16:44:59 +02:00
< p > WHONET 2019 software: < a href = 'http://www.whonet.org/software.html' > http://www.whonet.org/software.html< / a > < / p >
< p > European Commission Public Health PHARMACEUTICALS - COMMUNITY REGISTER: < a href = 'http://ec.europa.eu/health/documents/community-register/html/atc.htm' > http://ec.europa.eu/health/documents/community-register/html/atc.htm< / a > < / p >
2020-01-05 17:22:09 +01:00
< h2 class = "hasAnchor" id = "maturing-lifecycle" > < a class = "anchor" href = "#maturing-lifecycle" > < / a > Maturing lifecycle< / h2 >
< p > < img src = 'figures/lifecycle_maturing.svg' style = margin-bottom:5px / > < br / >
The < a href = 'lifecycle.html' > lifecycle< / a > of this function is < strong > maturing< / strong > . The unlying code of a maturing function has been roughed out, but finer details might still change. We will strive to maintain backward compatibility, but the function needs wider usage and more extensive testing in order to optimise the unlying code.< / p >
2019-05-10 16:44:59 +02:00
< h2 class = "hasAnchor" id = "whocc" > < a class = "anchor" href = "#whocc" > < / a > WHOCC< / h2 >
2019-10-04 15:36:12 +02:00
< p > < img src = 'figures/logo_who.png' height = 60px style = margin-bottom:5px / > < br / >
2019-11-18 12:10:47 +01:00
This package contains < strong > all ~550 antibiotic, antimycotic and antiviral drugs< / strong > and their Anatomical Therapeutic Chemical (ATC) codes, ATC groups and Defined Daily Dose (DDD) from the World Health Organization Collaborating Centre for Drug Statistics Methodology (WHOCC, < a href = 'https://www.whocc.no' > https://www.whocc.no< / a > ) and the Pharmaceuticals Community Register of the European Commission (< a href = 'http://ec.europa.eu/health/documents/community-register/html/atc.htm' > http://ec.europa.eu/health/documents/community-register/html/atc.htm< / a > ).< / p >
2019-05-10 16:44:59 +02:00
< p > These have become the gold standard for international drug utilisation monitoring and research.< / p >
< p > The WHOCC is located in Oslo at the Norwegian Institute of Public Health and funded by the Norwegian government. The European Commission is the executive of the European Union and promotes its general interest.< / p >
2019-11-28 22:32:17 +01:00
< p > < strong > NOTE: The WHOCC copyright does not allow use for commercial purposes, unlike any other info from this package.< / strong > See < a href = 'https://www.whocc.no/copyright_disclaimer/.' > https://www.whocc.no/copyright_disclaimer/.< / a > < / p >
2019-05-10 16:44:59 +02:00
< h2 class = "hasAnchor" id = "read-more-on-our-website-" > < a class = "anchor" href = "#read-more-on-our-website-" > < / a > Read more on our website!< / h2 >
2019-10-04 15:36:12 +02:00
2020-02-17 14:38:01 +01:00
< p > On our website < a href = 'https://msberends.gitlab.io/AMR' > https://msberends.gitlab.io/AMR< / a > you can find < a href = 'https://msberends.gitlab.io/AMR/articles/AMR.html' > a comprehensive tutorial< / a > about how to conduct AMR analysis, the < a href = 'https://msberends.gitlab.io/AMR/reference' > complete documentation of all functions< / a > (which reads a lot easier than here in R) and < a href = 'https://msberends.gitlab.io/AMR/articles/WHONET.html' > an example analysis using WHONET data< / a > .< / p >
2019-05-10 16:44:59 +02:00
< h2 class = "hasAnchor" id = "see-also" > < a class = "anchor" href = "#see-also" > < / a > See also< / h2 >
2019-11-28 22:32:17 +01:00
< div class = 'dont-index' > < p > < a href = 'antibiotics.html' > antibiotics< / a > for the dataframe that is being used to determine ATCs.< / p > < / div >
2019-05-10 16:44:59 +02:00
< h2 class = "hasAnchor" id = "examples" > < a class = "anchor" href = "#examples" > < / a > Examples< / h2 >
2020-01-08 11:30:33 +01:00
< pre class = "examples" > < span class = 'co' > # these examples all return "ERY", the ID of erythromycin:< / span >
2019-05-10 16:44:59 +02:00
< span class = 'fu' > as.ab< / span > (< span class = 'st' > "J01FA01"< / span > )
< span class = 'fu' > as.ab< / span > (< span class = 'st' > "J 01 FA 01"< / span > )
< span class = 'fu' > as.ab< / span > (< span class = 'st' > "Erythromycin"< / span > )
< span class = 'fu' > as.ab< / span > (< span class = 'st' > "eryt"< / span > )
< span class = 'fu' > as.ab< / span > (< span class = 'st' > " eryt 123"< / span > )
< span class = 'fu' > as.ab< / span > (< span class = 'st' > "ERYT"< / span > )
< span class = 'fu' > as.ab< / span > (< span class = 'st' > "ERY"< / span > )
2019-05-16 21:20:00 +02:00
< span class = 'fu' > as.ab< / span > (< span class = 'st' > "eritromicine"< / span > ) < span class = 'co' > # spelled wrong, yet works< / span >
2019-05-10 16:44:59 +02:00
< span class = 'fu' > as.ab< / span > (< span class = 'st' > "Erythrocin"< / span > ) < span class = 'co' > # trade name< / span >
< span class = 'fu' > as.ab< / span > (< span class = 'st' > "Romycin"< / span > ) < span class = 'co' > # trade name< / span >
2020-01-08 11:30:33 +01:00
< span class = 'co' > # spelling from different languages and dyslexia are no problem< / span >
< span class = 'fu' > < a href = 'ab_property.html' > ab_atc< / a > < / span > (< span class = 'st' > "ceftriaxon"< / span > )
2020-02-16 22:43:56 +01:00
< span class = 'fu' > < a href = 'ab_property.html' > ab_atc< / a > < / span > (< span class = 'st' > "cephtriaxone"< / span > ) < span class = 'co' > # small spelling error< / span >
< span class = 'fu' > < a href = 'ab_property.html' > ab_atc< / a > < / span > (< span class = 'st' > "cephthriaxone"< / span > ) < span class = 'co' > # or a bit more severe< / span >
< span class = 'fu' > < a href = 'ab_property.html' > ab_atc< / a > < / span > (< span class = 'st' > "seephthriaaksone"< / span > ) < span class = 'co' > # and even this works< / span >
2020-01-08 11:30:33 +01:00
< span class = 'co' > # use ab_* functions to get a specific properties (see ?ab_property);< / span >
2019-05-10 16:44:59 +02:00
< span class = 'co' > # they use as.ab() internally:< / span >
< span class = 'fu' > < a href = 'ab_property.html' > ab_name< / a > < / span > (< span class = 'st' > "J01FA01"< / span > ) < span class = 'co' > # "Erythromycin"< / span >
2019-10-04 15:36:12 +02:00
< span class = 'fu' > < a href = 'ab_property.html' > ab_name< / a > < / span > (< span class = 'st' > "eryt"< / span > ) < span class = 'co' > # "Erythromycin"< / span > < / pre >
2019-05-10 16:44:59 +02:00
< / div >
2020-04-13 21:09:56 +02:00
< div class = "col-md-3 hidden-xs hidden-sm" id = "pkgdown-sidebar" >
2020-04-17 19:16:30 +02:00
< nav id = "toc" data-toggle = "toc" class = "sticky-top" >
< h2 data-toc-skip > Contents< / h2 >
< / nav >
2019-05-10 16:44:59 +02:00
< / div >
< / div >
2019-10-04 15:36:12 +02:00
2019-05-10 16:44:59 +02:00
< footer >
< div class = "copyright" >
2020-02-17 14:38:01 +01:00
< 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 >
2019-05-10 16:44:59 +02:00
< / div >
< div class = "pkgdown" >
2020-04-17 19:16:30 +02:00
< p > Site built with < a href = "https://pkgdown.r-lib.org/" > pkgdown< / a > 1.5.0.< / p >
2019-05-10 16:44:59 +02:00
< / div >
2019-10-04 15:36:12 +02:00
2019-05-10 16:44:59 +02:00
< / footer >
< / div >
2019-10-04 15:36:12 +02:00
2019-05-10 16:44:59 +02:00
< / body >
< / html >
2019-10-04 15:36:12 +02:00
