P281424/AMR
1
0
Fork 0
mirror of https://github.com/msberends/AMR.git synced 2025-07-09 19:01:51 +02:00
Code Releases Activity

docu fix

Browse Source
This commit is contained in:
dr. M.S. (Matthijs) Berends
2023-12-04 08:19:02 +01:00
parent 7059568581
commit 83e92fd88c
8 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
R/mic.R
View File

@ -123,6 +123,8 @@ VALID_MIC_LEVELS <- c(
#' Use [droplevels()] to drop unused levels. At default, it will return a plain factor. Use `droplevels(..., as.mic = TRUE)` to maintain the `mic` class.
#'
#' With [rescale_mic()], existing MIC ranges can be rescaled to a defined range of MIC values. This can be useful to better compare MIC distributions.
#'
#' For `ggplot2`, use one of the [`scale_*_mic()`][scale_x_mic()] functions to plot MIC values. They allows custom MIC ranges and to plot intermediate log2 levels for missing MIC values.
#' @return Ordered [factor] with additional class [`mic`], that in mathematical operations acts as decimal numbers. Bare in mind that the outcome of any mathematical operation on MICs will return a [numeric] value.
#' @aliases mic
#' @export