mirror of
https://github.com/msberends/AMR.git
synced 2024-12-26 07:26:13 +01:00
completed old taxonomic names
This commit is contained in:
parent
768fe17324
commit
a6aa9e95fb
2
R/data.R
2
R/data.R
@ -150,7 +150,7 @@
|
|||||||
#'
|
#'
|
||||||
#' A data set containing old (previously valid or accepted) taxonomic names according to ITIS. This data set is used internally by \code{\link{as.mo}}.
|
#' A data set containing old (previously valid or accepted) taxonomic names according to ITIS. This data set is used internally by \code{\link{as.mo}}.
|
||||||
#' @inheritSection as.mo ITIS
|
#' @inheritSection as.mo ITIS
|
||||||
#' @format A \code{\link{data.frame}} with 2,384 observations and 5 variables:
|
#' @format A \code{\link{data.frame}} with 2,383 observations and 5 variables:
|
||||||
#' \describe{
|
#' \describe{
|
||||||
#' \item{\code{tsn}}{Old Taxonomic Serial Number (TSN), as defined by ITIS}
|
#' \item{\code{tsn}}{Old Taxonomic Serial Number (TSN), as defined by ITIS}
|
||||||
#' \item{\code{name}}{Old taxonomic name of the microorganism as found in ITIS, see Source}
|
#' \item{\code{name}}{Old taxonomic name of the microorganism as found in ITIS, see Source}
|
||||||
|
14
README.md
14
README.md
@ -30,6 +30,7 @@ Erwin E.A. Hassing<sup>2</sup>,
|
|||||||
* [Install from CRAN](#install-from-cran)
|
* [Install from CRAN](#install-from-cran)
|
||||||
* [Install from GitHub](#install-from-github)
|
* [Install from GitHub](#install-from-github)
|
||||||
* [How to use it?](#how-to-use-it)
|
* [How to use it?](#how-to-use-it)
|
||||||
|
* [ITIS](#itis)
|
||||||
* [New classes](#new-classes)
|
* [New classes](#new-classes)
|
||||||
* [Overwrite/force resistance based on EUCAST rules](#overwriteforce-resistance-based-on-eucast-rules)
|
* [Overwrite/force resistance based on EUCAST rules](#overwriteforce-resistance-based-on-eucast-rules)
|
||||||
* [Other (microbial) epidemiological functions](#other-microbial-epidemiological-functions)
|
* [Other (microbial) epidemiological functions](#other-microbial-epidemiological-functions)
|
||||||
@ -40,11 +41,7 @@ Erwin E.A. Hassing<sup>2</sup>,
|
|||||||
## Why this package?
|
## Why this package?
|
||||||
This R package was intended **to make microbial epidemiology easier**. Most functions contain extensive help pages to get started.
|
This R package was intended **to make microbial epidemiology easier**. Most functions contain extensive help pages to get started.
|
||||||
|
|
||||||
<a href="https://www.itis.gov"><img src="man/figures/itis_logo.jpg" height="50px"></a>
|
The `AMR` package basically does four important things:
|
||||||
|
|
||||||
This `AMR` package contains the **complete microbial taxonomic data** (with seven taxonomic ranks - from subkingdom to subspecies) from the publicly available Integrated Taxonomic Information System (ITIS, https://www.itis.gov). ITIS is a partnership of U.S., Canadian, and Mexican agencies and taxonomic specialists. The complete taxonomic kingdoms Bacteria, Fungi and Protozoa are included in this package, as well as all previously accepted names known to ITIS. This allows users to use authoritative taxonomic information for their data analyses on any microorganisms, not only human pathogens.
|
|
||||||
|
|
||||||
Combined with several new functions, this `AMR` package basically does four important things:
|
|
||||||
|
|
||||||
1. It **cleanses existing data**, by transforming it to reproducible and profound *classes*, making the most efficient use of R. These functions all use artificial intelligence to guess results that you would expect:
|
1. It **cleanses existing data**, by transforming it to reproducible and profound *classes*, making the most efficient use of R. These functions all use artificial intelligence to guess results that you would expect:
|
||||||
|
|
||||||
@ -122,6 +119,11 @@ library(AMR)
|
|||||||
help(package = "AMR")
|
help(package = "AMR")
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## ITIS
|
||||||
|
<img src="man/figures/logo_amr.png" height="50px"><img src="man/figures/plus.png" height="50px"><img src="man/figures/itis_logo.jpg" height="50px">
|
||||||
|
|
||||||
|
This `AMR` package contains the **complete microbial taxonomic data** (with seven taxonomic ranks - from subkingdom to subspecies) from the publicly available Integrated Taxonomic Information System (ITIS, https://www.itis.gov). ITIS is a partnership of U.S., Canadian, and Mexican agencies and taxonomic specialists. The complete taxonomic kingdoms Bacteria, Fungi and Protozoa are included in this package, as well as all previously accepted names known to ITIS. This allows users to use authoritative taxonomic information for their data analyses on any microorganisms, not only human pathogens.
|
||||||
|
|
||||||
### New classes
|
### New classes
|
||||||
This package contains two new S3 classes: `mic` for MIC values (e.g. from Vitek or Phoenix) and `rsi` for antimicrobial drug interpretations (i.e. S, I and R). Both are actually ordered factors under the hood (an MIC of `2` being higher than `<=1` but lower than `>=32`, and for class `rsi` factors are ordered as `S < I < R`).
|
This package contains two new S3 classes: `mic` for MIC values (e.g. from Vitek or Phoenix) and `rsi` for antimicrobial drug interpretations (i.e. S, I and R). Both are actually ordered factors under the hood (an MIC of `2` being higher than `<=1` but lower than `>=32`, and for class `rsi` factors are ordered as `S < I < R`).
|
||||||
Both classes have extensions for existing generic functions like `print`, `summary` and `plot`.
|
Both classes have extensions for existing generic functions like `print`, `summary` and `plot`.
|
||||||
@ -148,6 +150,8 @@ plot(septic_patients$cipr)
|
|||||||
|
|
||||||
![example_1_rsi](man/figures/rsi_example1.png)
|
![example_1_rsi](man/figures/rsi_example1.png)
|
||||||
|
|
||||||
|
<img src="man/figures/logo_amr.png" height="50px"><img src="man/figures/plus.png" height="50px"><img src="https://github.com/tidyverse/dplyr/blob/master/man/figures/logo.png" height="50px"><img src="man/figures/plus.png" height="50px"><img src="https://github.com/tidyverse/ggplot2/blob/master/man/figures/logo.png" height="50px">
|
||||||
|
|
||||||
Or use the `ggplot2` and `dplyr` packages to create more appealing plots:
|
Or use the `ggplot2` and `dplyr` packages to create more appealing plots:
|
||||||
```r
|
```r
|
||||||
library(dplyr)
|
library(dplyr)
|
||||||
|
Binary file not shown.
BIN
man/figures/plus.png
Normal file
BIN
man/figures/plus.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 556 B |
@ -4,7 +4,7 @@
|
|||||||
\name{microorganisms.old}
|
\name{microorganisms.old}
|
||||||
\alias{microorganisms.old}
|
\alias{microorganisms.old}
|
||||||
\title{Data set with old taxonomic data from ITIS}
|
\title{Data set with old taxonomic data from ITIS}
|
||||||
\format{A \code{\link{data.frame}} with 2,384 observations and 5 variables:
|
\format{A \code{\link{data.frame}} with 2,383 observations and 5 variables:
|
||||||
\describe{
|
\describe{
|
||||||
\item{\code{tsn}}{Old Taxonomic Serial Number (TSN), as defined by ITIS}
|
\item{\code{tsn}}{Old Taxonomic Serial Number (TSN), as defined by ITIS}
|
||||||
\item{\code{name}}{Old taxonomic name of the microorganism as found in ITIS, see Source}
|
\item{\code{name}}{Old taxonomic name of the microorganism as found in ITIS, see Source}
|
||||||
|
Loading…
Reference in New Issue
Block a user