AMR/man/rsi.Rd

24 lines
1.1 KiB
Plaintext
Raw Normal View History

2018-08-03 14:49:29 +02:00
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/portion.R
2018-08-03 14:49:29 +02:00
\name{rsi}
\alias{rsi}
\title{Calculate resistance of isolates}
\usage{
2018-08-10 15:01:05 +02:00
rsi(ab1, ab2 = NULL, interpretation = "IR", minimum = 30,
as_percent = FALSE, ...)
2018-08-03 14:49:29 +02:00
}
\arguments{
2018-08-23 00:40:36 +02:00
\item{ab1, ab2}{vector (or column) with antibiotic interpretations. It will be transformed internally with \code{\link{as.rsi}} if needed.}
2018-08-03 14:49:29 +02:00
2018-08-10 15:01:05 +02:00
\item{interpretation}{antimicrobial interpretation to check for}
2018-08-03 14:49:29 +02:00
2019-03-26 14:24:03 +01:00
\item{minimum}{the minimum allowed number of available (tested) isolates. Any isolate count lower than \code{minimum} will return \code{NA} with a warning. The default number of \code{30} isolates is advised by the Clinical and Laboratory Standards Institute (CLSI) as best practice, see Source.}
2018-08-03 14:49:29 +02:00
2018-10-16 09:59:31 +02:00
\item{as_percent}{a logical to indicate whether the output must be returned as a hundred fold with \% sign (a character). A value of \code{0.123456} will then be returned as \code{"12.3\%"}.}
2018-08-03 14:49:29 +02:00
2018-08-10 15:01:05 +02:00
\item{...}{deprecated parameters to support usage on older versions}
2018-08-03 14:49:29 +02:00
}
\description{
2018-08-10 15:01:05 +02:00
This function is deprecated. Use the \code{\link{portion}} functions instead.
2018-08-03 14:49:29 +02:00
}