mirror of
https://github.com/msberends/AMR.git
synced 2024-12-25 06:46:11 +01:00
documentation
This commit is contained in:
parent
ba3b237bdf
commit
61c0bdb7af
@ -1,5 +1,5 @@
|
||||
Package: AMR
|
||||
Version: 1.8.2.9072
|
||||
Version: 1.8.2.9073
|
||||
Date: 2022-12-28
|
||||
Title: Antimicrobial Resistance Data Analysis
|
||||
Description: Functions to simplify and standardise antimicrobial resistance (AMR)
|
||||
|
2
NEWS.md
2
NEWS.md
@ -1,4 +1,4 @@
|
||||
# AMR 1.8.2.9072
|
||||
# AMR 1.8.2.9073
|
||||
|
||||
*(this beta version will eventually become v2.0! We're happy to reach a new major milestone soon!)*
|
||||
|
||||
|
@ -29,7 +29,7 @@
|
||||
|
||||
#' Add Custom Microorganisms to This Package
|
||||
#'
|
||||
#' With [add_custom_microorganisms()] you can add your own custom antimicrobial drug codes to the `AMR` package.
|
||||
#' With [add_custom_microorganisms()] you can add your own custom microorganisms to the `AMR` package, such the non-taxonomic outcome of laboratory analysis.
|
||||
#' @param x a [data.frame] resembling the [microorganisms] data set, at least containing columns "genus" and "species"
|
||||
#' @details This function will fill in missing taxonomy for you, if specific taxonomic columns are missing, see *Examples*.
|
||||
#'
|
||||
@ -86,9 +86,10 @@
|
||||
#'
|
||||
#' # E. asburiae/cloacae is now a new microorganism:
|
||||
#' mo_name("Enterobacter asburiae/cloacae")
|
||||
#'
|
||||
#' # its code:
|
||||
#' as.mo("Enterobacter asburiae/cloacae")
|
||||
|
||||
#'
|
||||
#' # all internal algorithms will work as well:
|
||||
#' mo_name("Ent asburia cloacae")
|
||||
#'
|
||||
|
2
R/mo.R
2
R/mo.R
@ -371,7 +371,7 @@ as.mo <- function(x,
|
||||
}
|
||||
msg <- c(msg, paste0(
|
||||
"Microorganism translation was uncertain for ", examples,
|
||||
". Run `mo_uncertainties()` to review ", plural[2], "."
|
||||
". Run `mo_uncertainties()` to review ", plural[2], ", or use `add_custom_microorganisms()` to add own entries."
|
||||
))
|
||||
|
||||
for (m in msg) {
|
||||
|
@ -13,7 +13,7 @@ clear_custom_microorganisms()
|
||||
\item{x}{a \link{data.frame} resembling the \link{microorganisms} data set, at least containing columns "genus" and "species"}
|
||||
}
|
||||
\description{
|
||||
With \code{\link[=add_custom_microorganisms]{add_custom_microorganisms()}} you can add your own custom antimicrobial drug codes to the \code{AMR} package.
|
||||
With \code{\link[=add_custom_microorganisms]{add_custom_microorganisms()}} you can add your own custom microorganisms to the \code{AMR} package, such the non-taxonomic outcome of laboratory analysis.
|
||||
}
|
||||
\details{
|
||||
This function will fill in missing taxonomy for you, if specific taxonomic columns are missing, see \emph{Examples}.
|
||||
@ -67,8 +67,10 @@ add_custom_microorganisms(
|
||||
|
||||
# E. asburiae/cloacae is now a new microorganism:
|
||||
mo_name("Enterobacter asburiae/cloacae")
|
||||
|
||||
# its code:
|
||||
as.mo("Enterobacter asburiae/cloacae")
|
||||
|
||||
# all internal algorithms will work as well:
|
||||
mo_name("Ent asburia cloacae")
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user