mirror of https://github.com/msberends/AMR.git
doc fix
This commit is contained in:
parent
d4ae174c28
commit
ef716f6ee3
|
@ -1,5 +1,5 @@
|
||||||
Package: AMR
|
Package: AMR
|
||||||
Version: 1.8.2.9128
|
Version: 1.8.2.9129
|
||||||
Date: 2023-02-15
|
Date: 2023-02-15
|
||||||
Title: Antimicrobial Resistance Data Analysis
|
Title: Antimicrobial Resistance Data Analysis
|
||||||
Description: Functions to simplify and standardise antimicrobial resistance (AMR)
|
Description: Functions to simplify and standardise antimicrobial resistance (AMR)
|
||||||
|
|
2
NEWS.md
2
NEWS.md
|
@ -1,4 +1,4 @@
|
||||||
# AMR 1.8.2.9128
|
# AMR 1.8.2.9129
|
||||||
|
|
||||||
*(this beta version will eventually become v2.0! We're happy to reach a new major milestone soon!)*
|
*(this beta version will eventually become v2.0! We're happy to reach a new major milestone soon!)*
|
||||||
|
|
||||||
|
|
|
@ -102,7 +102,7 @@
|
||||||
#' "Study Group", "Control Group"))
|
#' "Study Group", "Control Group"))
|
||||||
#' ```
|
#' ```
|
||||||
#'
|
#'
|
||||||
#' All types of antibiograms can be generated with the functions as described on this page, and can be plotted (using [ggplot2::autoplot()] or base \R [plot()]/[barplot()]) or printed into R Markdown / Quarto formats for reports. Use functions from specific 'table reporting' packages to transform the output of [antibiogram()] to your needs, e.g. `flextable::as_flextable()` or `gt::gt()`.
|
#' All types of antibiograms can be generated with the functions as described on this page, and can be plotted (using [ggplot2::autoplot()] or base \R [plot()]/[barplot()]) or printed into R Markdown / Quarto formats for reports using `print()`. Use functions from specific 'table reporting' packages to transform the output of [antibiogram()] to your needs, e.g. `flextable::as_flextable()` or `gt::gt()`.
|
||||||
#'
|
#'
|
||||||
#' Note that for combination antibiograms, it is important to realise that susceptibility can be calculated in two ways, which can be set with the `only_all_tested` argument (defaults to `FALSE`). See this example for two antibiotics, Drug A and Drug B, about how [antibiogram()] works to calculate the %SI:
|
#' Note that for combination antibiograms, it is important to realise that susceptibility can be calculated in two ways, which can be set with the `only_all_tested` argument (defaults to `FALSE`). See this example for two antibiotics, Drug A and Drug B, about how [antibiogram()] works to calculate the %SI:
|
||||||
#'
|
#'
|
||||||
|
|
17
index.md
17
index.md
|
@ -78,7 +78,7 @@ This base R snippet will work in any version of R since April 2013 (R-3.0).
|
||||||
|
|
||||||
The `AMR` package supports generating traditional, combined, syndromic, and even weighted-incidence syndromic combination antibiograms (WISCA).
|
The `AMR` package supports generating traditional, combined, syndromic, and even weighted-incidence syndromic combination antibiograms (WISCA).
|
||||||
|
|
||||||
If used inside R Markdown or Quarto, the table will be printed in the right output format automatically (such as markdown, LaTeX, HTML, etc.).
|
If used inside R Markdown or Quarto, the table will be printed in the right output format automatically (such as markdown, LaTeX, HTML, etc.) when using `print()` on an antibiogram object.
|
||||||
|
|
||||||
```r
|
```r
|
||||||
antibiogram(example_isolates,
|
antibiogram(example_isolates,
|
||||||
|
@ -111,6 +111,21 @@ antibiogram(example_isolates,
|
||||||
|Gram-negative (641-693) | 88| 99| 98|
|
|Gram-negative (641-693) | 88| 99| 98|
|
||||||
|Gram-positive (345-1044) | 86| 98| 95|
|
|Gram-positive (345-1044) | 86| 98| 95|
|
||||||
|
|
||||||
|
Like many other functions in this package, `antibiograms()` comes with support for 20 languages that are often detected automatically based on system language:
|
||||||
|
|
||||||
|
```r
|
||||||
|
antibiogram(example_isolates,
|
||||||
|
antibiotics = c("CIP", "TOB", "GEN"),
|
||||||
|
mo_transform = "gramstain",
|
||||||
|
ab_transform = "name",
|
||||||
|
language = "uk") # Ukrainian
|
||||||
|
```
|
||||||
|
|
||||||
|
|Збудник (N min-max) | Гентаміцин| Тобраміцин| Ципрофлоксацин|
|
||||||
|
|:------------------------|----------:|----------:|--------------:|
|
||||||
|
|Грамнегативні (684-686) | 96| 96| 91|
|
||||||
|
|Грампозитивні (665-1170) | 63| 34| 77|
|
||||||
|
|
||||||
|
|
||||||
#### Calculating resistance per group
|
#### Calculating resistance per group
|
||||||
|
|
||||||
|
|
|
@ -124,7 +124,7 @@ your_data \%>\%
|
||||||
}\if{html}{\out{</div>}}
|
}\if{html}{\out{</div>}}
|
||||||
}
|
}
|
||||||
|
|
||||||
All types of antibiograms can be generated with the functions as described on this page, and can be plotted (using \code{\link[ggplot2:autoplot]{ggplot2::autoplot()}} or base \R \code{\link[=plot]{plot()}}/\code{\link[=barplot]{barplot()}}) or printed into R Markdown / Quarto formats for reports. Use functions from specific 'table reporting' packages to transform the output of \code{\link[=antibiogram]{antibiogram()}} to your needs, e.g. \code{flextable::as_flextable()} or \code{gt::gt()}.
|
All types of antibiograms can be generated with the functions as described on this page, and can be plotted (using \code{\link[ggplot2:autoplot]{ggplot2::autoplot()}} or base \R \code{\link[=plot]{plot()}}/\code{\link[=barplot]{barplot()}}) or printed into R Markdown / Quarto formats for reports using \code{print()}. Use functions from specific 'table reporting' packages to transform the output of \code{\link[=antibiogram]{antibiogram()}} to your needs, e.g. \code{flextable::as_flextable()} or \code{gt::gt()}.
|
||||||
|
|
||||||
Note that for combination antibiograms, it is important to realise that susceptibility can be calculated in two ways, which can be set with the \code{only_all_tested} argument (defaults to \code{FALSE}). See this example for two antibiotics, Drug A and Drug B, about how \code{\link[=antibiogram]{antibiogram()}} works to calculate the \%SI:
|
Note that for combination antibiograms, it is important to realise that susceptibility can be calculated in two ways, which can be set with the \code{only_all_tested} argument (defaults to \code{FALSE}). See this example for two antibiotics, Drug A and Drug B, about how \code{\link[=antibiogram]{antibiogram()}} works to calculate the \%SI:
|
||||||
|
|
||||||
|
|
|
@ -52,7 +52,7 @@ $(document).ready(function() {
|
||||||
// add doctoral titles to authors
|
// add doctoral titles to authors
|
||||||
function doct_tit(x) {
|
function doct_tit(x) {
|
||||||
if (typeof(x) != "undefined") {
|
if (typeof(x) != "undefined") {
|
||||||
x = x.replace(/Author, maintainer/g, "Principle developer");
|
x = x.replace(/Author, maintainer/g, "Principle maintainer");
|
||||||
x = x.replace(/Author, contributor/g, "Contributing maintainer");
|
x = x.replace(/Author, contributor/g, "Contributing maintainer");
|
||||||
x = x.replace(/Thesis advisor/g, "(former) Doctoral advisor");
|
x = x.replace(/Thesis advisor/g, "(former) Doctoral advisor");
|
||||||
// contributors
|
// contributors
|
||||||
|
|
Loading…
Reference in New Issue