mirror of
https://github.com/msberends/AMR.git
synced 2025-07-09 02:03:04 +02:00
documentation for 'data.table' AB selectors
This commit is contained in:
@ -29,7 +29,8 @@ sir_confidence_interval(
|
||||
as_percent = FALSE,
|
||||
only_all_tested = FALSE,
|
||||
confidence_level = 0.95,
|
||||
side = "both"
|
||||
side = "both",
|
||||
collapse = FALSE
|
||||
)
|
||||
|
||||
proportion_R(..., minimum = 30, as_percent = FALSE, only_all_tested = FALSE)
|
||||
@ -77,6 +78,8 @@ sir_df(
|
||||
|
||||
\item{side}{the side of the confidence interval to return. The default is \code{"both"} for a length 2 vector, but can also be (abbreviated as) \code{"min"}/\code{"left"}/\code{"lower"}/\code{"less"} or \code{"max"}/\code{"right"}/\code{"higher"}/\code{"greater"}.}
|
||||
|
||||
\item{collapse}{a \link{logical} to indicate whether the output values should be 'collapsed', i.e. be merged together into one value, or a character value to use for collapsing}
|
||||
|
||||
\item{data}{a \link{data.frame} containing columns with class \code{\link{sir}} (see \code{\link[=as.sir]{as.sir()}})}
|
||||
|
||||
\item{translate_ab}{a column name of the \link{antibiotics} data set to translate the antibiotic abbreviations to, using \code{\link[=ab_property]{ab_property()}}}
|
||||
@ -172,6 +175,10 @@ sir_confidence_interval(example_isolates$AMX)
|
||||
sir_confidence_interval(example_isolates$AMX,
|
||||
confidence_level = 0.975
|
||||
)
|
||||
sir_confidence_interval(example_isolates$AMX,
|
||||
confidence_level = 0.975,
|
||||
collapse = ", "
|
||||
)
|
||||
|
||||
# determines \%S+I:
|
||||
susceptibility(example_isolates$AMX)
|
||||
|
Reference in New Issue
Block a user