Change a dataset used as reference for calculating SHAP values. Reference dataset is initially set with data argument in unifying function. Usually reference dataset is dataset used to train the model. Important property of reference dataset is that SHAP values for each observation add up to its deviation from mean prediction for a reference dataset.

set_reference_dataset(unified_model, x)

Arguments

unified_model

Unified model representation of the model created with a (model).unify function. (model_unified.object).

x

Reference dataset. A data.frame or matrix with the same columns as in the training set of the model.

Value

model_unified.object. Unified representation of the model as created with a (model).unify function, but with changed reference dataset (Cover column containing updated values).

Examples

# \donttest{
library(gbm)
data <- fifa20$data[colnames(fifa20$data) != 'work_rate']
data['value_eur'] <- fifa20$target
gbm_model <- gbm::gbm(
formula = value_eur ~ .,
  data = data,
  distribution = "laplace",
  n.trees = 20,
  interaction.depth = 4,
  n.cores = 1)
unified <- gbm.unify(gbm_model, data)
set_reference_dataset(unified, data[200:700, ])
#>     Tree Node   Feature Decision.type Split Yes  No Missing Prediction Cover
#> 1      0    0   overall            <=  65.5   2   9      13         NA   501
#> 2      0    1 potential            <=  74.5   3   4       8         NA     0
#> 3      0    2      <NA>          <NA>    NA  NA  NA      NA  -6000.000     0
#> 4      0    3   overall            <=  62.5   5   6       7         NA     0
#> 5      0    4      <NA>          <NA>    NA  NA  NA      NA  10000.000     0
#> 6      0    5      <NA>          <NA>    NA  NA  NA      NA  45000.000     0
#> 7      0    6      <NA>          <NA>    NA  NA  NA      NA  27589.438     0
#> 8      0    7      <NA>          <NA>    NA  NA  NA      NA  -1344.274     0
#> 9      0    8 potential            <=  68.5  10  11      12         NA   501
#> 10     0    9      <NA>          <NA>    NA  NA  NA      NA  30000.000     0
#> 11     0   10      <NA>          <NA>    NA  NA  NA      NA 205000.000   501
#> 12     0   11      <NA>          <NA>    NA  NA  NA      NA 179056.892     0
#> 13     0   12      <NA>          <NA>    NA  NA  NA      NA  95459.241     0
#> 14     1    0   overall            <=  66.5  15  22      26         NA   501
#> 15     1    1 potential            <=  71.5  16  17      21         NA     0
#> 16     1    2      <NA>          <NA>    NA  NA  NA      NA  -1900.000     0
#> 17     1    3   overall            <=  63.5  18  19      20         NA     0
#> 18     1    4      <NA>          <NA>    NA  NA  NA      NA  12500.000     0
#> 19     1    5      <NA>          <NA>    NA  NA  NA      NA  44100.000     0
#> 20     1    6      <NA>          <NA>    NA  NA  NA      NA  25839.253     0
#> 21     1    7      <NA>          <NA>    NA  NA  NA      NA   6348.533     0
#> 22     1    8 potential            <=  69.5  23  24      25         NA   501
#> 23     1    9      <NA>          <NA>    NA  NA  NA      NA  35500.000     0
#> 24     1   10      <NA>          <NA>    NA  NA  NA      NA 248000.000   501
#> 25     1   11      <NA>          <NA>    NA  NA  NA      NA 213937.715     0
#> 26     1   12      <NA>          <NA>    NA  NA  NA      NA 105543.407     0
#> 27     2    0   overall            <=  67.5  28  35      39         NA   501
#> 28     2    1   overall            <=  63.5  29  30      34         NA     0
#> 29     2    2      <NA>          <NA>    NA  NA  NA      NA  -3250.000     0
#> 30     2    3       age            <=  23.5  31  32      33         NA     0
#> 31     2    4      <NA>          <NA>    NA  NA  NA      NA  42090.000     0
#> 32     2    5      <NA>          <NA>    NA  NA  NA      NA  24200.000     0
#> 33     2    6      <NA>          <NA>    NA  NA  NA      NA  30767.725     0
#> 34     2    7      <NA>          <NA>    NA  NA  NA      NA  10966.745     0
#> 35     2    8       age            <=  33.5  36  37      38         NA   501
#> 36     2    9      <NA>          <NA>    NA  NA  NA      NA 226700.000   462
#> 37     2   10      <NA>          <NA>    NA  NA  NA      NA  16700.000    39
#> 38     2   11      <NA>          <NA>    NA  NA  NA      NA 211280.611     0
#> 39     2   12      <NA>          <NA>    NA  NA  NA      NA  94849.136     0
#> 40     3    0   overall            <=  69.5  41  51      52         NA   501
#> 41     3    1 potential            <=  75.5  42  46      50         NA     0
#> 42     3    2   overall            <=  64.5  43  44      45         NA     0
#> 43     3    3      <NA>          <NA>    NA  NA  NA      NA   1870.000     0
#> 44     3    4      <NA>          <NA>    NA  NA  NA      NA  27530.000     0
#> 45     3    5      <NA>          <NA>    NA  NA  NA      NA  12305.996     0
#> 46     3    6   overall            <=  61.5  47  48      49         NA     0
#> 47     3    7      <NA>          <NA>    NA  NA  NA      NA  13575.000     0
#> 48     3    8      <NA>          <NA>    NA  NA  NA      NA  47575.000     0
#> 49     3    9      <NA>          <NA>    NA  NA  NA      NA  40929.351     0
#> 50     3   10      <NA>          <NA>    NA  NA  NA      NA  15901.485     0
#> 51     3   11      <NA>          <NA>    NA  NA  NA      NA 327530.000   501
#> 52     3   12      <NA>          <NA>    NA  NA  NA      NA 112264.565     0
#> 53     4    0   overall            <=  69.5  54  64      65         NA   501
#> 54     4    1 potential            <=  73.5  55  59      63         NA     0
#> 55     4    2   overall            <=  63.5  56  57      58         NA     0
#> 56     4    3      <NA>          <NA>    NA  NA  NA      NA    928.000     0
#> 57     4    4      <NA>          <NA>    NA  NA  NA      NA  27027.000     0
#> 58     4    5      <NA>          <NA>    NA  NA  NA      NA  13703.590     0
#> 59     4    6   overall            <=  62.5  60  61      62         NA     0
#> 60     4    7      <NA>          <NA>    NA  NA  NA      NA  18488.000     0
#> 61     4    8      <NA>          <NA>    NA  NA  NA      NA  45123.500     0
#> 62     4    9      <NA>          <NA>    NA  NA  NA      NA  37183.106     0
#> 63     4   10      <NA>          <NA>    NA  NA  NA      NA  18583.646     0
#> 64     4   11      <NA>          <NA>    NA  NA  NA      NA 288277.000   501
#> 65     4   12      <NA>          <NA>    NA  NA  NA      NA 100149.729     0
#> 66     5    0 potential            <=  71.5  67  74      78         NA   501
#> 67     5    1   overall            <=  63.5  68  69      73         NA     0
#> 68     5    2      <NA>          <NA>    NA  NA  NA      NA   3335.200     0
#> 69     5    3 defending            <=  57.5  70  71      72         NA     0
#> 70     5    4      <NA>          <NA>    NA  NA  NA      NA  34314.300     0
#> 71     5    5      <NA>          <NA>    NA  NA  NA      NA  20414.300     0
#> 72     5    6      <NA>          <NA>    NA  NA  NA      NA   6814.300     0
#> 73     5    7      <NA>          <NA>    NA  NA  NA      NA  14335.314     0
#> 74     5    8   overall            <=  62.5  75  76      77         NA   501
#> 75     5    9      <NA>          <NA>    NA  NA  NA      NA  19395.200     0
#> 76     5   10      <NA>          <NA>    NA  NA  NA      NA 135260.150   501
#> 77     5   11      <NA>          <NA>    NA  NA  NA      NA 118218.863     0
#> 78     5   12      <NA>          <NA>    NA  NA  NA      NA  64339.005     0
#> 79     6    0   overall            <=  70.5  80  87      91         NA   501
#> 80     6    1 potential            <=  76.5  81  85      86         NA     0
#> 81     6    2 dribbling            <=  63.5  82  83      84         NA     0
#> 82     6    3      <NA>          <NA>    NA  NA  NA      NA  14501.680     0
#> 83     6    4      <NA>          <NA>    NA  NA  NA      NA  29065.285     0
#> 84     6    5      <NA>          <NA>    NA  NA  NA      NA   3099.680     0
#> 85     6    6      <NA>          <NA>    NA  NA  NA      NA  42585.135     0
#> 86     6    7      <NA>          <NA>    NA  NA  NA      NA  20406.988     0
#> 87     6    8       age            <=  32.5  88  89      90         NA   501
#> 88     6    9      <NA>          <NA>    NA  NA  NA      NA 392923.285   435
#> 89     6   10      <NA>          <NA>    NA  NA  NA      NA  32923.285    66
#> 90     6   11      <NA>          <NA>    NA  NA  NA      NA 351549.239     0
#> 91     6   12      <NA>          <NA>    NA  NA  NA      NA 105846.689     0
#> 92     7    0   overall            <=  70.5  93 100     104         NA   501
#> 93     7    1 dribbling            <=  64.5  94  95      99         NA     0
#> 94     7    2      <NA>          <NA>    NA  NA  NA      NA  18551.512     0
#> 95     7    3 potential            <=  77.5  96  97      98         NA     0
#> 96     7    4      <NA>          <NA>    NA  NA  NA      NA  30986.341     0
#> 97     7    5      <NA>          <NA>    NA  NA  NA      NA  62936.622     0
#> 98     7    6      <NA>          <NA>    NA  NA  NA      NA  35288.527     0
#> 99     7    7      <NA>          <NA>    NA  NA  NA      NA   8691.712     0
#> 100    7    8 potential            <=  71.5 101 102     103         NA   501
#> 101    7    9      <NA>          <NA>    NA  NA  NA      NA   8615.542     0
#> 102    7   10      <NA>          <NA>    NA  NA  NA      NA 357130.957   501
#> 103    7   11      <NA>          <NA>    NA  NA  NA      NA 333273.819     0
#> 104    7   12      <NA>          <NA>    NA  NA  NA      NA 105033.366     0
#> 105    8    0   overall            <=  71.5 106 116     117         NA   501
#> 106    8    1   overall            <=  61.5 107 108     115         NA     0
#> 107    8    2      <NA>          <NA>    NA  NA  NA      NA   7409.529     0
#> 108    8    3       age            <=  29.5 109 113     114         NA     0
#> 109    8    4  shooting            <=  52.5 110 111     112         NA     0
#> 110    8    5      <NA>          <NA>    NA  NA  NA      NA  31165.470     0
#> 111    8    6      <NA>          <NA>    NA  NA  NA      NA  37696.361     0
#> 112    8    7      <NA>          <NA>    NA  NA  NA      NA  23270.496     0
#> 113    8    8      <NA>          <NA>    NA  NA  NA      NA  12877.707     0
#> 114    8    9      <NA>          <NA>    NA  NA  NA      NA  29226.383     0
#> 115    8   10      <NA>          <NA>    NA  NA  NA      NA  22551.625     0
#> 116    8   11      <NA>          <NA>    NA  NA  NA      NA 374917.861   501
#> 117    8   12      <NA>          <NA>    NA  NA  NA      NA  99934.165     0
#> 118    9    0 potential            <=  73.5 119 126     130         NA   501
#> 119    9    1   overall            <=  62.5 120 121     125         NA     0
#> 120    9    2      <NA>          <NA>    NA  NA  NA      NA  11955.408     0
#> 121    9    3       age            <=  30.5 122 123     124         NA     0
#> 122    9    4      <NA>          <NA>    NA  NA  NA      NA  32794.230     0
#> 123    9    5      <NA>          <NA>    NA  NA  NA      NA   6137.948     0
#> 124    9    6      <NA>          <NA>    NA  NA  NA      NA  25925.561     0
#> 125    9    7      <NA>          <NA>    NA  NA  NA      NA  20689.447     0
#> 126    9    8   overall            <=  68.5 127 128     129         NA   501
#> 127    9    9      <NA>          <NA>    NA  NA  NA      NA  32880.836     0
#> 128    9   10      <NA>          <NA>    NA  NA  NA      NA 340926.075   501
#> 129    9   11      <NA>          <NA>    NA  NA  NA      NA 228765.535     0
#> 130    9   12      <NA>          <NA>    NA  NA  NA      NA  95914.679     0
#> 131   10    0   overall            <=  71.5 132 142     143         NA   501
#> 132   10    1   overall            <=  60.5 133 134     141         NA     0
#> 133   10    2      <NA>          <NA>    NA  NA  NA      NA  11259.867     0
#> 134   10    3 defending            <=  55.5 135 139     140         NA     0
#> 135   10    4 potential            <=  65.5 136 137     138         NA     0
#> 136   10    5      <NA>          <NA>    NA  NA  NA      NA  26172.807     0
#> 137   10    6      <NA>          <NA>    NA  NA  NA      NA  37843.693     0
#> 138   10    7      <NA>          <NA>    NA  NA  NA      NA  36045.117     0
#> 139   10    8      <NA>          <NA>    NA  NA  NA      NA  28033.357     0
#> 140   10    9      <NA>          <NA>    NA  NA  NA      NA  20070.697     0
#> 141   10   10      <NA>          <NA>    NA  NA  NA      NA  25546.205     0
#> 142   10   11      <NA>          <NA>    NA  NA  NA      NA 263833.467   501
#> 143   10   12      <NA>          <NA>    NA  NA  NA      NA  78006.428     0
#> 144   11    0   overall            <=  72.5 145 155     156         NA   501
#> 145   11    1   overall            <=  61.5 146 147     154         NA     0
#> 146   11    2      <NA>          <NA>    NA  NA  NA      NA  14633.880     0
#> 147   11    3       age            <=  29.5 148 152     153         NA     0
#> 148   11    4 defending            <=  53.5 149 150     151         NA     0
#> 149   11    5      <NA>          <NA>    NA  NA  NA      NA  38644.279     0
#> 150   11    6      <NA>          <NA>    NA  NA  NA      NA  32457.504     0
#> 151   11    7      <NA>          <NA>    NA  NA  NA      NA  25208.999     0
#> 152   11    8      <NA>          <NA>    NA  NA  NA      NA  16272.650     0
#> 153   11    9      <NA>          <NA>    NA  NA  NA      NA  30290.717     0
#> 154   11   10      <NA>          <NA>    NA  NA  NA      NA  25943.805     0
#> 155   11   11      <NA>          <NA>    NA  NA  NA      NA 423450.121   501
#> 156   11   12      <NA>          <NA>    NA  NA  NA      NA  98059.515     0
#> 157   12    0 potential            <=  75.5 158 165     169         NA   501
#> 158   12    1  shooting            <=  58.5 159 163     164         NA     0
#> 159   12    2   overall            <=  60.5 160 161     162         NA     0
#> 160   12    3      <NA>          <NA>    NA  NA  NA      NA  15670.492     0
#> 161   12    4      <NA>          <NA>    NA  NA  NA      NA  29251.305     0
#> 162   12    5      <NA>          <NA>    NA  NA  NA      NA  24656.318     0
#> 163   12    6      <NA>          <NA>    NA  NA  NA      NA  34583.609     0
#> 164   12    7      <NA>          <NA>    NA  NA  NA      NA  15006.767     0
#> 165   12    8   overall            <=  69.5 166 167     168         NA   501
#> 166   12    9      <NA>          <NA>    NA  NA  NA      NA  35211.754     0
#> 167   12   10      <NA>          <NA>    NA  NA  NA      NA 448605.109   501
#> 168   12   11      <NA>          <NA>    NA  NA  NA      NA 297947.822     0
#> 169   12   12      <NA>          <NA>    NA  NA  NA      NA  93541.405     0
#> 170   13    0   overall            <=  72.5 171 181     182         NA   501
#> 171   13    1   overall            <=  60.5 172 173     180         NA     0
#> 172   13    2      <NA>          <NA>    NA  NA  NA      NA  16795.996     0
#> 173   13    3       age            <=  30.5 174 178     179         NA     0
#> 174   13    4 potential            <=  65.5 175 176     177         NA     0
#> 175   13    5      <NA>          <NA>    NA  NA  NA      NA  27326.174     0
#> 176   13    6      <NA>          <NA>    NA  NA  NA      NA  34984.612     0
#> 177   13    7      <NA>          <NA>    NA  NA  NA      NA  34162.273     0
#> 178   13    8      <NA>          <NA>    NA  NA  NA      NA  11474.603     0
#> 179   13    9      <NA>          <NA>    NA  NA  NA      NA  30509.071     0
#> 180   13   10      <NA>          <NA>    NA  NA  NA      NA  27136.733     0
#> 181   13   11      <NA>          <NA>    NA  NA  NA      NA 307244.598   501
#> 182   13   12      <NA>          <NA>    NA  NA  NA      NA  78045.931     0
#> 183   14    0   overall            <=  73.5 184 194     195         NA   501
#> 184   14    1   overall            <=  59.5 185 186     193         NA     0
#> 185   14    2      <NA>          <NA>    NA  NA  NA      NA  17423.844     0
#> 186   14    3 potential            <=  65.5 187 188     192         NA     0
#> 187   14    4      <NA>          <NA>    NA  NA  NA      NA  26498.033     0
#> 188   14    5 defending            <=  65.5 189 190     191         NA     0
#> 189   14    6      <NA>          <NA>    NA  NA  NA      NA  35970.031     0
#> 190   14    7      <NA>          <NA>    NA  NA  NA      NA  20455.462     0
#> 191   14    8      <NA>          <NA>    NA  NA  NA      NA  24271.379     0
#> 192   14    9      <NA>          <NA>    NA  NA  NA      NA  30828.106     0
#> 193   14   10      <NA>          <NA>    NA  NA  NA      NA  28288.115     0
#> 194   14   11      <NA>          <NA>    NA  NA  NA      NA 430020.138   501
#> 195   14   12      <NA>          <NA>    NA  NA  NA      NA  87851.185     0
#> 196   15    0 potential            <=  77.5 197 207     208         NA   501
#> 197   15    1   overall            <=  59.5 198 199     206         NA     0
#> 198   15    2      <NA>          <NA>    NA  NA  NA      NA  19181.459     0
#> 199   15    3       age            <=  31.5 200 204     205         NA     0
#> 200   15    4   overall            <=  73.5 201 202     203         NA     0
#> 201   15    5      <NA>          <NA>    NA  NA  NA      NA  32515.038     0
#> 202   15    6      <NA>          <NA>    NA  NA  NA      NA 190518.124     0
#> 203   15    7      <NA>          <NA>    NA  NA  NA      NA  44323.938     0
#> 204   15    8      <NA>          <NA>    NA  NA  NA      NA   7527.248     0
#> 205   15    9      <NA>          <NA>    NA  NA  NA      NA  39092.544     0
#> 206   15   10      <NA>          <NA>    NA  NA  NA      NA  35434.928     0
#> 207   15   11      <NA>          <NA>    NA  NA  NA      NA 190518.124   501
#> 208   15   12      <NA>          <NA>    NA  NA  NA      NA  60821.126     0
#> 209   16    0   overall            <=  73.5 210 220     221         NA   501
#> 210   16    1   overall            <=  59.5 211 212     219         NA     0
#> 211   16    2      <NA>          <NA>    NA  NA  NA      NA  19955.866     0
#> 212   16    3 potential            <=  65.5 213 214     218         NA     0
#> 213   16    4      <NA>          <NA>    NA  NA  NA      NA  27664.137     0
#> 214   16    5 defending            <=  63.5 215 216     217         NA     0
#> 215   16    6      <NA>          <NA>    NA  NA  NA      NA  35801.585     0
#> 216   16    7      <NA>          <NA>    NA  NA  NA      NA  24910.791     0
#> 217   16    8      <NA>          <NA>    NA  NA  NA      NA  21599.831     0
#> 218   16    9      <NA>          <NA>    NA  NA  NA      NA  30713.588     0
#> 219   16   10      <NA>          <NA>    NA  NA  NA      NA  28652.985     0
#> 220   16   11      <NA>          <NA>    NA  NA  NA      NA 374966.312   501
#> 221   16   12      <NA>          <NA>    NA  NA  NA      NA  78218.346     0
#> 222   17    0   overall            <=  73.5 223 233     234         NA   501
#> 223   17    1   overall            <=  59.5 224 225     232         NA     0
#> 224   17    2      <NA>          <NA>    NA  NA  NA      NA  21460.279     0
#> 225   17    3 potential            <=  64.5 226 227     231         NA     0
#> 226   17    4      <NA>          <NA>    NA  NA  NA      NA  26984.260     0
#> 227   17    5       age            <=  31.5 228 229     230         NA     0
#> 228   17    6      <NA>          <NA>    NA  NA  NA      NA  34103.867     0
#> 229   17    7      <NA>          <NA>    NA  NA  NA      NA   6781.122     0
#> 230   17    8      <NA>          <NA>    NA  NA  NA      NA  31441.749     0
#> 231   17    9      <NA>          <NA>    NA  NA  NA      NA  30994.589     0
#> 232   17   10      <NA>          <NA>    NA  NA  NA      NA  29177.600     0
#> 233   17   11      <NA>          <NA>    NA  NA  NA      NA 326969.681   501
#> 234   17   12      <NA>          <NA>    NA  NA  NA      NA  72547.910     0
#> 235   18    0   overall            <=  73.5 236 246     247         NA   501
#> 236   18    1   overall            <=  59.5 237 238     245         NA     0
#> 237   18    2      <NA>          <NA>    NA  NA  NA      NA  22814.251     0
#> 238   18    3 potential            <=  64.5 239 240     244         NA     0
#> 239   18    4      <NA>          <NA>    NA  NA  NA      NA  27861.426     0
#> 240   18    5 defending            <=  65.5 241 242     243         NA     0
#> 241   18    6      <NA>          <NA>    NA  NA  NA      NA  35223.742     0
#> 242   18    7      <NA>          <NA>    NA  NA  NA      NA  21657.938     0
#> 243   18    8      <NA>          <NA>    NA  NA  NA      NA  25725.586     0
#> 244   18    9      <NA>          <NA>    NA  NA  NA      NA  31252.369     0
#> 245   18   10      <NA>          <NA>    NA  NA  NA      NA  29632.068     0
#> 246   18   11      <NA>          <NA>    NA  NA  NA      NA 311772.712   501
#> 247   18   12      <NA>          <NA>    NA  NA  NA      NA  71093.375     0
#> 248   19    0 potential            <=  79.5 249 259     260         NA   501
#> 249   19    1   overall            <=  58.5 250 251     258         NA    35
#> 250   19    2      <NA>          <NA>    NA  NA  NA      NA  23794.274     0
#> 251   19    3 potential            <=  65.5 252 253     257         NA    35
#> 252   19    4      <NA>          <NA>    NA  NA  NA      NA  29576.504     0
#> 253   19    5       age            <=  32.5 254 255     256         NA    35
#> 254   19    6      <NA>          <NA>    NA  NA  NA      NA  34443.248    20
#> 255   19    7      <NA>          <NA>    NA  NA  NA      NA -29284.026    15
#> 256   19    8      <NA>          <NA>    NA  NA  NA      NA  29474.862     0
#> 257   19    9      <NA>          <NA>    NA  NA  NA      NA  29489.713     0
#> 258   19   10      <NA>          <NA>    NA  NA  NA      NA  28670.816     0
#> 259   19   11      <NA>          <NA>    NA  NA  NA      NA 384095.441   466
#> 260   19   12      <NA>          <NA>    NA  NA  NA      NA  65461.678     0
# }