1
0
mirror of https://github.com/msberends/AMR.git synced 2024-12-25 06:46:11 +01:00

(v0.7.0.9004) pkgdown update

This commit is contained in:
dr. M.S. (Matthijs) Berends 2019-06-09 08:57:54 +02:00
parent ec48f1d83b
commit f6c47c8c88
10 changed files with 144 additions and 161 deletions

View File

@ -1,6 +1,6 @@
Package: AMR
Version: 0.7.0.9003
Date: 2019-06-08
Version: 0.7.0.9004
Date: 2019-06-09
Title: Antimicrobial Resistance Analysis
Authors@R: c(
person(

View File

@ -1,4 +1,4 @@
# AMR 0.7.0.9003
# AMR 0.7.0.9004
#### New
* Support for all scientifically published pathotypes of *E. coli* to date. Supported are: AIEC (Adherent-Invasive *E. coli*), ATEC (Atypical Entero-pathogenic *E. coli*), DAEC (Diffusely Adhering *E. coli*), EAEC (Entero-Aggresive *E. coli*), EHEC (Entero-Haemorrhagic *E. coli*), EIEC (Entero-Invasive *E. coli*), EPEC (Entero-Pathogenic *E. coli*), ETEC (Entero-Toxigenic *E. coli*), NMEC (Neonatal Meningitiscausing *E. coli*), STEC (Shiga-toxin producing *E. coli*) and UPEC (Uropathogenic *E. coli*). All these lead to the microbial ID of *E. coli*:

View File

@ -19,152 +19,160 @@
# Visit our website for more info: https://msberends.gitlab.io/AMR. #
# ==================================================================== #
title: 'AMR (for R)'
url: 'https://msberends.gitlab.io/AMR'
title: "AMR (for R)"
url: "https://msberends.gitlab.io/AMR"
development:
mode: release # improves indexing by search engines
mode: "release" # improves indexing by search engines
version_tooltip: "Latest development version"
news:
one_page: true
navbar:
title: 'AMR (for R)'
title: "AMR (for R)"
left:
- text: 'Home'
icon: 'fa-home'
href: 'index.html'
- text: 'How to'
icon: 'fa-question-circle'
- text: "Home"
icon: "fa-home"
href: "index.html"
- text: "How to"
icon: "fa-question-circle"
menu:
- text: 'Conduct AMR analysis'
icon: 'fa-directions'
href: 'articles/AMR.html'
- text: 'Predict antimicrobial resistance'
icon: 'fa-dice'
href: 'articles/resistance_predict.html'
- text: 'Determine multi-drug resistance (MDR)'
icon: 'fa-skull-crossbones'
href: 'articles/MDR.html'
- text: 'Work with WHONET data'
icon: 'fa-globe-americas'
href: 'articles/WHONET.html'
- text: 'Import data from SPSS/SAS/Stata'
icon: 'fa-file-upload'
href: 'articles/SPSS.html'
- text: 'Apply EUCAST rules'
icon: 'fa-exchange-alt'
href: 'articles/EUCAST.html'
- text: 'Get properties of a microorganism'
icon: 'fa-bug'
href: 'reference/mo_property.html' # reference instead of article
- text: 'Get properties of an antibiotic'
icon: 'fa-capsules'
href: 'reference/ab_property.html' # reference instead of article
- text: 'Create frequency tables'
icon: 'fa-sort-amount-down'
href: 'articles/freq.html'
- text: 'Use the G-test'
icon: 'fa-clipboard-check'
href: 'reference/g.test.html' # reference instead of article
- text: 'Other: benchmarks'
icon: 'fa-shipping-fast'
href: 'articles/benchmarks.html'
- text: 'Manual'
icon: 'fa-book-open'
href: 'reference/'
- text: 'Authors'
icon: 'fa-users'
href: 'authors.html'
- text: 'Changelog'
icon: 'far fa-newspaper'
href: 'news/'
- text: "Conduct AMR analysis"
icon: "fa-directions"
href: "articles/AMR.html"
- text: "Predict antimicrobial resistance"
icon: "fa-dice"
href: "articles/resistance_predict.html"
- text: "Determine multi-drug resistance (MDR)"
icon: "fa-skull-crossbones"
href: "articles/MDR.html"
- text: "Work with WHONET data"
icon: "fa-globe-americas"
href: "articles/WHONET.html"
- text: "Import data from SPSS/SAS/Stata"
icon: "fa-file-upload"
href: "articles/SPSS.html"
- text: "Apply EUCAST rules"
icon: "fa-exchange-alt"
href: "articles/EUCAST.html"
- text: "Get properties of a microorganism"
icon: "fa-bug"
href: "reference/mo_property.html" # reference instead of article
- text: "Get properties of an antibiotic"
icon: "fa-capsules"
href: "reference/ab_property.html" # reference instead of article
- text: "Create frequency tables"
icon: "fa-sort-amount-down"
href: "articles/freq.html"
# - text: "Use the G-test"
# icon: "fa-clipboard-check"
# href: "reference/g.test.html" # reference instead of article
- text: "Other: benchmarks"
icon: "fa-shipping-fast"
href: "articles/benchmarks.html"
- text: "Manual"
icon: "fa-book-open"
href: "reference/"
- text: "Authors"
icon: "fa-users"
href: "authors.html"
- text: "Changelog"
icon: "far fa-newspaper"
href: "news/"
right:
- text: 'Source Code'
icon: 'fab fa-gitlab'
href: 'https://gitlab.com/msberends/AMR'
- text: 'Licence'
icon: 'fa-book'
href: 'LICENSE-text.html'
- text: "Source Code"
icon: "fab fa-gitlab"
href: "https://gitlab.com/msberends/AMR"
- text: "Licence"
icon: "fa-book"
href: "LICENSE-text.html"
reference:
- title: 'Background information'
- title: "Background information"
desc: >
Some pages about our package and its external sources. Be sure to read our [How To's](./../articles/index.html)
for more information about how to work with functions in this package.
contents:
- '`AMR`'
- '`catalogue_of_life`'
- '`catalogue_of_life_version`'
- '`WHOCC`'
- title: 'Cleaning your data'
- "`AMR`"
- "`catalogue_of_life`"
- "`catalogue_of_life_version`"
- "`WHOCC`"
- title: "Cleaning your data"
desc: >
Functions for cleaning and optimising your data, to be able to add
variables later on (like taxonomic properties) or to fix and extend
antibiotic interpretations by applying [EUCAST rules](http://www.eucast.org/expert_rules_and_intrinsic_resistance/).
contents:
- starts_with("as.")
- '`mo_source`'
- '`eucast_rules`'
- '`rsi_translation`'
- '`guess_ab_col`'
- '`read.4D`'
- title: 'Adding variables to your data'
- "`mo_source`"
- "`eucast_rules`"
- "`rsi_translation`"
- "`guess_ab_col`"
- "`read.4D`"
- title: "Adding variables to your data"
desc: >
Functions to add new data to existing data, like the determination
of first isolates, multi-drug resistant microorganisms (MDRO), getting
properties of microorganisms or antibiotics and determining the age of
patients or divide ages into age groups.
contents:
- '`first_isolate`'
- '`mdro`'
- '`key_antibiotics`'
- '`mo_property`'
- '`ab_property`'
- '`age`'
- '`age_groups`'
- '`p.symbol`'
- '`join`'
- '`atc_online_property`'
- title: 'Analysing your data'
- "`first_isolate`"
- "`mdro`"
- "`key_antibiotics`"
- "`mo_property`"
- "`ab_property`"
- "`age`"
- "`age_groups`"
- "`p.symbol`"
- "`join`"
- "`atc_online_property`"
- title: "Analysing your data"
desc: >
Functions for conducting AMR analysis, like counting isolates, calculating
resistance or susceptibility, creating frequency tables or make plots.
contents:
- '`availability`'
- '`count`'
- '`portion`'
- '`filter_ab_class`'
- '`freq`'
- '`g.test`'
- '`ggplot_rsi`'
- '`kurtosis`'
- '`resistance_predict`'
- '`skewness`'
- title: 'Included data sets'
- "`availability`"
- "`count`"
- "`portion`"
- "`filter_ab_class`"
- "`freq`"
- "`g.test`"
- "`ggplot_rsi`"
- "`kurtosis`"
- "`resistance_predict`"
- "`skewness`"
- title: "Included data sets"
desc: >
References for microorganisms and antibiotics, and even a
genuine data set with isolates from septic patients.
contents:
- '`antibiotics`'
- '`microorganisms`'
- '`septic_patients`'
- '`WHONET`'
- '`microorganisms.codes`'
- '`microorganisms.old`'
- "`antibiotics`"
- "`microorganisms`"
- "`septic_patients`"
- "`WHONET`"
- "`microorganisms.codes`"
- "`microorganisms.old`"
- title: Other functions
desc: >
These functions are mostly for internal use, but some of
them may also be suitable for your analysis. Especially the
'like' function can be useful: `if (x %like% y) {...}`.
contents:
- '`get_locale`'
- '`like`'
- title: Deprecated functions
- "`get_locale`"
- "`like`"
- title: Extended functions
desc: >
These functions are extensions of functions in other packages.
contents:
- "`extended-functions`"
- title: functions
desc: >
These functions are deprecated, meaning that they still
work but show a warning with every use and will be removed
in a future version.
contents:
- '`AMR-deprecated`'
- "`AMR-deprecated`"
authors:
Matthijs S. Berends:
@ -179,11 +187,11 @@ authors:
href: https://www.rug.nl/staff/b.sinha/
template:
assets: pkgdown/logos # use logos in this folder
assets: "pkgdown/logos" # use logos in this folder
params:
noindex: false
bootswatch: flatly
bootswatch: "flatly"
docsearch:
# using algolia.com
api_key: 'f737050abfd4d726c63938e18f8c496e'
index_name: 'amr'
api_key: "f737050abfd4d726c63938e18f8c496e"
index_name: "amr"

View File

@ -78,7 +78,7 @@
</button>
<span class="navbar-brand">
<a class="navbar-link" href="index.html">AMR (for R)</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.7.0.9003</span>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">0.7.0.9004</span>
</span>
</div>
@ -163,13 +163,6 @@
Create frequency tables
</a>
</li>
<li>
<a href="reference/g.test.html">
<span class="fa fa-clipboard-check"></span>
Use the G-test
</a>
</li>
<li>
<a href="articles/benchmarks.html">
<span class="fa fa-shipping-fast"></span>

View File

@ -78,7 +78,7 @@
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">AMR (for R)</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.7.0.9003</span>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">0.7.0.9004</span>
</span>
</div>
@ -163,13 +163,6 @@
Create frequency tables
</a>
</li>
<li>
<a href="../reference/g.test.html">
<span class="fa fa-clipboard-check"></span>
Use the G-test
</a>
</li>
<li>
<a href="../articles/benchmarks.html">
<span class="fa fa-shipping-fast"></span>

View File

@ -78,7 +78,7 @@
</button>
<span class="navbar-brand">
<a class="navbar-link" href="index.html">AMR (for R)</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.7.0.9003</span>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">0.7.0.9004</span>
</span>
</div>
@ -163,13 +163,6 @@
Create frequency tables
</a>
</li>
<li>
<a href="reference/g.test.html">
<span class="fa fa-clipboard-check"></span>
Use the G-test
</a>
</li>
<li>
<a href="articles/benchmarks.html">
<span class="fa fa-shipping-fast"></span>

View File

@ -42,7 +42,7 @@
</button>
<span class="navbar-brand">
<a class="navbar-link" href="index.html">AMR (for R)</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.7.0.9003</span>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">0.7.0.9004</span>
</span>
</div>
@ -127,13 +127,6 @@
Create frequency tables
</a>
</li>
<li>
<a href="reference/g.test.html">
<span class="fa fa-clipboard-check"></span>
Use the G-test
</a>
</li>
<li>
<a href="articles/benchmarks.html">
<span class="fa fa-shipping-fast"></span>

View File

@ -78,7 +78,7 @@
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">AMR (for R)</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.7.0.9003</span>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">0.7.0.9004</span>
</span>
</div>
@ -163,13 +163,6 @@
Create frequency tables
</a>
</li>
<li>
<a href="../reference/g.test.html">
<span class="fa fa-clipboard-check"></span>
Use the G-test
</a>
</li>
<li>
<a href="../articles/benchmarks.html">
<span class="fa fa-shipping-fast"></span>
@ -239,9 +232,9 @@
</div>
<div id="amr-0709003" class="section level1">
<div id="amr-0709004" class="section level1">
<h1 class="page-header">
<a href="#amr-0709003" class="anchor"></a>AMR 0.7.0.9003<small> Unreleased </small>
<a href="#amr-0709004" class="anchor"></a>AMR 0.7.0.9004<small> Unreleased </small>
</h1>
<div id="new" class="section level4">
<h4 class="hasAnchor">
@ -1108,7 +1101,7 @@ Using <code><a href="../reference/as.mo.html">as.mo(..., allow_uncertain = 3)</a
<div id="tocnav">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#amr-0709003">0.7.0.9003</a></li>
<li><a href="#amr-0709004">0.7.0.9004</a></li>
<li><a href="#amr-070">0.7.0</a></li>
<li><a href="#amr-061">0.6.1</a></li>
<li><a href="#amr-060">0.6.0</a></li>

View File

@ -78,7 +78,7 @@
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">AMR (for R)</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.7.0.9003</span>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">0.7.0.9004</span>
</span>
</div>
@ -163,13 +163,6 @@
Create frequency tables
</a>
</li>
<li>
<a href="../reference/g.test.html">
<span class="fa fa-clipboard-check"></span>
Use the G-test
</a>
</li>
<li>
<a href="../articles/benchmarks.html">
<span class="fa fa-shipping-fast"></span>
@ -555,7 +548,21 @@
</tbody><tbody>
<tr>
<th colspan="2">
<h2 id="section-deprecated-functions" class="hasAnchor"><a href="#section-deprecated-functions" class="anchor"></a>Deprecated functions</h2>
<h2 id="section-extended-functions" class="hasAnchor"><a href="#section-extended-functions" class="anchor"></a>Extended functions</h2>
<p class="section-desc"><p>These functions are extensions of functions in other packages.</p></p>
</th>
</tr>
<tr>
<td>
<p><code><a href="extended-functions.html">scale_type.mo()</a></code> <code><a href="extended-functions.html">scale_type.ab()</a></code> </p>
</td>
<td><p>Extended functions</p></td>
</tr>
</tbody><tbody>
<tr>
<th colspan="2">
<h2 id="section-functions" class="hasAnchor"><a href="#section-functions" class="anchor"></a>functions</h2>
<p class="section-desc"><p>These functions are deprecated, meaning that they still work but show a warning with every use and will be removed in a future version.</p></p>
</th>
</tr>
@ -579,7 +586,8 @@
<li><a href="#section-analysing-your-data">Analysing your data</a></li>
<li><a href="#section-included-data-sets">Included data sets</a></li>
<li><a href="#section-other-functions">Other functions</a></li>
<li><a href="#section-deprecated-functions">Deprecated functions</a></li>
<li><a href="#section-extended-functions">Extended functions</a></li>
<li><a href="#section-functions">functions</a></li>
</ul>
</div>
</div>

View File

@ -52,7 +52,9 @@ echo "••••••••••••••••••••••••
echo "• Reloading/documenting package •"
echo "•••••••••••••••••••••••••••••••••"
Rscript -e "devtools::load_all(quiet = TRUE)"
echo "Documenting..."
Rscript -e "suppressMessages(devtools::document())"
echo "Installing..."
Rscript -e "devtools::install(quiet = TRUE, dependencies = FALSE)"
echo
echo "••••••••••••••••••••••••••"