Skip to content

For user-defined lower_limit and/or upper_limit bound, ensure that the values in the .pred column are coerced to these bounds.

Usage

bound_prediction(
  x,
  lower_limit = -Inf,
  upper_limit = Inf,
  call = rlang::current_env()
)

Arguments

x

A data frame that contains a numeric column named .pred.

lower_limit, upper_limit

Single numerics (or NA) that define constraints on .pred.

call

The call to be displayed in warnings or errors.

Value

x with potentially adjusted values.

Examples

data(solubility_test, package = "yardstick")

names(solubility_test) <- c("solubility", ".pred")

bound_prediction(solubility_test, lower_limit = -1)
#>     solubility       .pred
#> 1         0.93  0.36775219
#> 2         0.85 -0.15032196
#> 3         0.81 -0.50518438
#> 4         0.74  0.53981158
#> 5         0.61 -0.47927183
#> 6         0.58  0.73772216
#> 7         0.57  0.45857371
#> 8         0.56  0.58613930
#> 9         0.52  0.09587705
#> 10        0.45 -0.39248631
#> 11        0.40 -0.39248631
#> 12        0.36 -1.00000000
#> 13        0.22 -0.42208506
#> 14        0.08 -0.11257503
#> 15        0.07 -0.55242508
#> 16        0.02 -0.97431079
#> 17        0.00 -0.15320302
#> 18       -0.01 -0.37951441
#> 19       -0.07  0.88317691
#> 20       -0.12 -1.00000000
#> 21       -0.17  0.03893535
#> 22       -0.29 -0.02510738
#> 23       -0.38 -0.51435942
#> 24       -0.38 -0.69655564
#> 25       -0.39 -0.83937780
#> 26       -0.42 -0.62948972
#> 27       -0.44 -0.92769946
#> 28       -0.46  0.54452824
#> 29       -0.48 -1.00000000
#> 30       -0.60 -1.00000000
#> 31       -0.63 -1.00000000
#> 32       -0.66 -0.87822537
#> 33       -0.72 -0.45310275
#> 34       -0.72 -0.49465265
#> 35       -0.80 -0.56171857
#> 36       -0.80 -0.89522719
#> 37       -0.82  0.42570777
#> 38       -0.82 -0.87822537
#> 39       -0.84  0.05436526
#> 40       -0.85 -1.00000000
#> 41       -0.85 -0.61627916
#> 42       -0.87 -1.00000000
#> 43       -0.89 -1.00000000
#> 44       -0.90  0.36172934
#> 45       -0.96 -1.00000000
#> 46       -0.96 -0.69388075
#> 47       -0.99 -0.72904783
#> 48       -1.01 -0.87822537
#> 49       -1.09 -1.00000000
#> 50       -1.12 -1.00000000
#> 51       -1.14 -0.47101466
#> 52       -1.17 -1.00000000
#> 53       -1.19 -1.00000000
#> 54       -1.22 -1.00000000
#> 55       -1.27 -1.00000000
#> 56       -1.28 -1.00000000
#> 57       -1.32 -1.00000000
#> 58       -1.38 -1.00000000
#> 59       -1.39 -1.00000000
#> 60       -1.42 -1.00000000
#> 61       -1.47 -1.00000000
#> 62       -1.47 -1.00000000
#> 63       -1.50 -0.59558842
#> 64       -1.52 -0.85624767
#> 65       -1.54 -1.00000000
#> 66       -1.55 -1.00000000
#> 67       -1.56 -1.00000000
#> 68       -1.57 -1.00000000
#> 69       -1.60 -1.00000000
#> 70       -1.60 -1.00000000
#> 71       -1.62 -1.00000000
#> 72       -1.64 -1.00000000
#> 73       -1.67 -1.00000000
#> 74       -1.70 -1.00000000
#> 75       -1.70 -1.00000000
#> 76       -1.71 -1.00000000
#> 77       -1.71 -1.00000000
#> 78       -1.75 -1.00000000
#> 79       -1.78 -1.00000000
#> 80       -1.78 -1.00000000
#> 81       -1.82 -1.00000000
#> 82       -1.87 -1.00000000
#> 83       -1.89 -1.00000000
#> 84       -1.92 -1.00000000
#> 85       -1.92 -1.00000000
#> 86       -1.92 -1.00000000
#> 87       -1.94 -1.00000000
#> 88       -1.99 -1.00000000
#> 89       -2.00 -1.00000000
#> 90       -2.05 -1.00000000
#> 91       -2.06 -1.00000000
#> 92       -2.08 -1.00000000
#> 93       -2.10 -1.00000000
#> 94       -2.11 -0.94582854
#> 95       -2.12 -0.95282378
#> 96       -2.17 -1.00000000
#> 97       -2.21 -1.00000000
#> 98       -2.24 -1.00000000
#> 99       -2.24 -1.00000000
#> 100      -2.29 -1.00000000
#> 101      -2.31 -1.00000000
#> 102      -2.32 -1.00000000
#> 103      -2.35 -1.00000000
#> 104      -2.35 -1.00000000
#> 105      -2.36 -1.00000000
#> 106      -2.36 -1.00000000
#> 107      -2.38 -1.00000000
#> 108      -2.42 -1.00000000
#> 109      -2.43 -1.00000000
#> 110      -2.44 -1.00000000
#> 111      -2.52 -1.00000000
#> 112      -2.53 -1.00000000
#> 113      -2.57 -1.00000000
#> 114      -2.62 -1.00000000
#> 115      -2.62 -1.00000000
#> 116      -2.64 -1.00000000
#> 117      -2.64 -1.00000000
#> 118      -2.70 -1.00000000
#> 119      -2.82 -1.00000000
#> 120      -2.88 -1.00000000
#> 121      -2.89 -1.00000000
#> 122      -2.92 -1.00000000
#> 123      -2.93 -1.00000000
#> 124      -2.96 -1.00000000
#> 125      -2.98 -1.00000000
#> 126      -3.01 -1.00000000
#> 127      -3.01 -1.00000000
#> 128      -3.02 -1.00000000
#> 129      -3.07 -1.00000000
#> 130      -3.09 -1.00000000
#> 131      -3.11 -1.00000000
#> 132      -3.13 -1.00000000
#> 133      -3.14 -1.00000000
#> 134      -3.15 -1.00000000
#> 135      -3.22 -1.00000000
#> 136      -3.26 -1.00000000
#> 137      -3.27 -1.00000000
#> 138      -3.27 -1.00000000
#> 139      -3.30 -1.00000000
#> 140      -3.31 -1.00000000
#> 141      -3.33 -1.00000000
#> 142      -3.37 -1.00000000
#> 143      -3.43 -1.00000000
#> 144      -3.43 -1.00000000
#> 145      -3.48 -1.00000000
#> 146      -3.51 -1.00000000
#> 147      -3.59 -1.00000000
#> 148      -3.61 -1.00000000
#> 149      -3.63 -1.00000000
#> 150      -3.63 -1.00000000
#> 151      -3.68 -1.00000000
#> 152      -3.71 -1.00000000
#> 153      -3.74 -1.00000000
#> 154      -3.75 -1.00000000
#> 155      -3.75 -1.00000000
#> 156      -3.77 -1.00000000
#> 157      -3.77 -1.00000000
#> 158      -3.78 -1.00000000
#> 159      -3.81 -1.00000000
#> 160      -3.95 -1.00000000
#> 161      -3.96 -1.00000000
#> 162      -3.96 -1.00000000
#> 163      -4.00 -1.00000000
#> 164      -4.02 -1.00000000
#> 165      -4.04 -1.00000000
#> 166      -4.12 -1.00000000
#> 167      -4.15 -1.00000000
#> 168      -4.16 -1.00000000
#> 169      -4.17 -1.00000000
#> 170      -4.21 -1.00000000
#> 171      -4.23 -1.00000000
#> 172      -4.25 -1.00000000
#> 173      -4.30 -1.00000000
#> 174      -4.31 -1.00000000
#> 175      -4.35 -1.00000000
#> 176      -4.40 -1.00000000
#> 177      -4.40 -1.00000000
#> 178      -4.43 -1.00000000
#> 179      -4.46 -1.00000000
#> 180      -4.47 -1.00000000
#> 181      -4.51 -1.00000000
#> 182      -4.60 -1.00000000
#> 183      -4.64 -1.00000000
#> 184      -4.69 -1.00000000
#> 185      -4.71 -1.00000000
#> 186      -4.77 -1.00000000
#> 187      -4.95 -1.00000000
#> 188      -4.98 -1.00000000
#> 189      -5.21 -1.00000000
#> 190      -5.22 -1.00000000
#> 191      -5.28 -1.00000000
#> 192      -5.31 -1.00000000
#> 193      -5.35 -1.00000000
#> 194      -5.37 -1.00000000
#> 195      -5.40 -1.00000000
#> 196      -5.43 -1.00000000
#> 197      -5.65 -1.00000000
#> 198      -5.66 -1.00000000
#> 199      -6.70 -1.00000000
#> 200      -5.72 -1.00000000
#> 201      -6.00 -1.00000000
#> 202      -6.25 -1.00000000
#> 203      -6.26 -1.00000000
#> 204      -6.27 -1.00000000
#> 205      -6.35 -1.00000000
#> 206      -6.57 -1.00000000
#> 207      -6.62 -1.00000000
#> 208      -6.96 -1.00000000
#> 209      -7.02 -1.00000000
#> 210      -7.20 -1.00000000
#> 211      -7.28 -1.00000000
#> 212      -7.32 -1.00000000
#> 213      -7.39 -1.00000000
#> 214      -7.82 -1.00000000
#> 215      -8.23 -1.00000000
#> 216      -8.94 -1.00000000
#> 217       1.07  0.04202675
#> 218       0.43 -0.02565046
#> 219       0.32  0.25187579
#> 220       0.00 -0.38765781
#> 221      -0.40 -1.00000000
#> 222      -0.52 -0.48786224
#> 223      -0.55 -1.00000000
#> 224      -0.60 -0.83526706
#> 225      -0.62 -1.00000000
#> 226      -0.85 -1.00000000
#> 227      -0.89 -1.00000000
#> 228      -0.93 -1.00000000
#> 229      -0.96 -0.37328992
#> 230      -1.06 -1.00000000
#> 231      -1.10 -1.00000000
#> 232      -1.12 -0.56163091
#> 233      -1.15 -0.82058137
#> 234      -1.28 -0.22588800
#> 235      -1.30 -1.00000000
#> 236      -1.31 -1.00000000
#> 237      -1.35 -1.00000000
#> 238      -1.39 -1.00000000
#> 239      -1.41 -1.00000000
#> 240      -1.41 -1.00000000
#> 241      -1.42 -0.76974442
#> 242      -1.46 -1.00000000
#> 243      -1.50 -1.00000000
#> 244      -1.50 -1.00000000
#> 245      -1.52 -1.00000000
#> 246      -1.52 -1.00000000
#> 247      -1.59 -1.00000000
#> 248      -1.61 -1.00000000
#> 249      -1.63 -1.00000000
#> 250      -1.71 -1.00000000
#> 251      -1.83 -1.00000000
#> 252      -2.05 -1.00000000
#> 253      -2.06 -1.00000000
#> 254      -2.07 -1.00000000
#> 255      -2.15 -1.00000000
#> 256      -2.16 -1.00000000
#> 257      -1.99  0.13067110
#> 258      -2.36 -1.00000000
#> 259      -2.38 -1.00000000
#> 260      -2.39 -1.00000000
#> 261      -2.46 -1.00000000
#> 262      -2.49 -1.00000000
#> 263      -2.54 -1.00000000
#> 264      -2.55 -1.00000000
#> 265      -2.63 -1.00000000
#> 266      -2.64 -1.00000000
#> 267      -2.67 -1.00000000
#> 268      -2.68 -1.00000000
#> 269      -2.77 -1.00000000
#> 270      -2.78 -1.00000000
#> 271      -2.82 -1.00000000
#> 272      -2.92 -1.00000000
#> 273      -3.03 -1.00000000
#> 274      -3.12 -1.00000000
#> 275      -3.16 -1.00000000
#> 276      -3.19 -1.00000000
#> 277      -3.54 -1.00000000
#> 278      -3.54 -1.00000000
#> 279      -3.59 -1.00000000
#> 280      -3.66 -1.00000000
#> 281      -3.68 -1.00000000
#> 282      -3.75 -1.00000000
#> 283      -3.76 -1.00000000
#> 284      -3.78 -1.00000000
#> 285      -3.80 -1.00000000
#> 286      -3.80 -1.00000000
#> 287      -3.85 -1.00000000
#> 288      -3.89 -1.00000000
#> 289      -3.95 -1.00000000
#> 290      -4.29 -1.00000000
#> 291      -4.42 -1.00000000
#> 292      -4.48 -1.00000000
#> 293      -4.48 -1.00000000
#> 294      -4.53 -1.00000000
#> 295      -4.63 -1.00000000
#> 296      -4.73 -1.00000000
#> 297      -4.84 -1.00000000
#> 298      -4.89 -1.00000000
#> 299      -4.89 -1.00000000
#> 300      -5.26 -1.00000000
#> 301      -6.09 -1.00000000
#> 302      -6.29 -1.00000000
#> 303      -6.29 -1.00000000
#> 304      -6.89 -1.00000000
#> 305      -6.96 -1.00000000
#> 306      -7.00 -1.00000000
#> 307      -7.05 -1.00000000
#> 308      -8.30 -1.00000000
#> 309      -8.66 -1.00000000
#> 310      -9.03 -1.00000000
#> 311     -10.41 -1.00000000
#> 312      -7.89 -1.00000000
#> 313      -2.32 -1.00000000
#> 314       0.39 -1.00000000
#> 315      -2.90 -1.00000000
#> 316      -2.47 -1.00000000