Skip to contents

An enumeration of bin labels for positivity status

Source: R/cut_by.R
bins.Rd

bins() returns a character vector representing the levels used to classify biomarker values into diagnostic bins:

  • "-", for negative / unimpaired / normal status

  • "~", for indeterminate / borderline / uncertain status

  • "+", for positive / impaired / abnormal status

Usage

bins(n = 2)

Arguments

n

Number of levels to be returned. Use n = 2 for binary classification (negative and positive). Use n = 3 to also include the intermediate category ("~").

Value

A character vector of length 2 or 3, representing diagnostic bin labels.

Examples

# Use `n = 2` for normal (`"-"`) and abnormal (`"+"`)
bins(n = 2)
#> [1] "-" "+"

# Use `n = 3` to also include the indeterminate category (`"~"`)
bins(n = 3)
#> [1] "-" "~" "+"