This function crafts a solo_box tile displaying a red orange green color. The color is defined by the value of the target compared to the thresholds.
solo_gradient_box(
value = NULL,
txt = NULL,
former = NULL,
size = "md",
icon = NULL,
target = 100,
thresholdHigh = 90,
thresholdLow = 50,
relative = FALSE,
link = NULL,
units = NULL,
hover = NULL,
hide_value = FALSE,
textModifier = "h1",
revert = FALSE,
pretty = FALSE,
...
)The numeric value you want to highlight (the main enchilada)
Optional subtext that should appear under the value
The last value that should be used as information in the chevron, or for relative mode
Optional size specified in the bootstrap css classes: "xs","sm","md","lg")
Optional glyphicon that should be displayed from https://getbootstrap.com/docs/3.3/components/ you need only supply the name of thing you want, like "check"... not the full "gyphicon-check"
Optional target that the value should be compared against. Use with thresholdHigh and thresholdLow. Note, 'target' is ignored in relative mode, and you might want to change the thresholdHigh to 105 and threholdLow to 95 (to trigger red/green if +/- 5% outside the margins)
Optional edge between "green" and "orange" from 0-100 as a percent of target. IE, this value represents the RATIO of the VALUE to the target that, if above or equal to the thresholdHigh will show as green, and if not, as orange. Use w/ target and thresholdLow.
Optional border between "orange" and "red" from 0-100 as a percent of target. IE, this value represents the RATIO of the VALUE to the target that, if above or equal to the thresholdLow will show as orange, and if not, as red. Use w/ target and thresholdHigh.
Alternate mode where the 'value' is compared against `former` rather than 'target'. This mode is suitable to change the color of the button based on previous values rather than comparison to a standard.
Optional hyperlink that should be followed on click
Optional units that should be displayed after Value
Optional tooltip, or text that will show up when a user rests their mouse over the tile.
Optionally and paradoxically hide value. Normally FALSE, change this value to TRUE in order to suppress the large number, but still take advantage of the conditional formatting.
Optional css category of "large" text. In this case, the icon, value and unit. Default=h1
Invert colorbox. Green become red and red become green.
Optionally allow numbers to become embellished. Accepted values are FALSE (default), or the desired divider (",", ".", " "). If this option is not left as FALSE, rounding is automatically implemented.
Optional additional html elements. For example, if you would like two buttons to fit into a section in a flexdashboard, you could specify "style = 'width:100%;height:50%'"
HTML code for a button with desired properties
DETAILS
g1 <- solo_gradient_box(value = 40)
g2 <- solo_gradient_box(
value = 40, target = 50,
thresholdHigh = 80, thresholdLow = 60
)
g3 <- solo_gradient_box(
value = 20, txt = "Test1", target = 50,
thresholdHigh = 80, thresholdLow = 60, hide_value = TRUE
)
g4 <- solo_gradient_box(
value = 35, txt = "Test2", target = 50,
thresholdHigh = 80, thresholdLow = 60, hide_value = TRUE
)
## This one shows relative and revert options. Since 29160
## is about 6\% higher than 27420, it is triggered by the "high"
## level, but since revert is TRUE, insteaad of showing as
## green, it's showing as red.
g5 <- solo_gradient_box(
value = 29160, former = 27420,
relative = TRUE, revert = TRUE,
thresholdHigh = 105, thresholdLow = 95
)
finisher(title = "Item", divs = div_maker(
subtitle = "subitems",
textModifier = "h1", g1, g2, g3, g4, g5
))
Item