forked from facebookincubator/GeoLift
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CHANGELOG
346 lines (225 loc) · 11.3 KB
/
CHANGELOG
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
GeoLift v2.7.3 (Release date: 2023-08-02)
=========================================
Changes:
* Fix issue with Cumulative value plot Confidence Interval calculations.
GeoLift v2.7.2 (Release date: 2023-07-19)
=========================================
Changes:
* Move CommutingZones to Suggests dependency and add usage guide.
GeoLift v2.7.1 (Release date: 2023-07-07)
=========================================
Changes:
* Included knitr in imports.R and explicitly declared methods being used.
GeoLift v2.7.0 (Release date: 2023-07-01)
=========================================
Changes:
* Included the CommutingZones package to cluster locations in GeoDataRead.
GeoLift v2.6.06 (Release date: 2023-05-19)
=========================================
Changes:
* Explicitly called the functions we are using from other packages.
* Removed magrittr, ggrepel, parallel and graphics from imports.R
GeoLift v2.6.05 (Release date: 2023-05-16)
=========================================
Changes:
* Added GetMultiCellWeights() to obtain the synthetic control weights of Multi Cell tests.
GeoLift v2.6.04 (Release date: 2023-04-24)
=========================================
Changes:
* Added additional capabilies in the execution of inference through Conformal Inference, providing the option to customize the
method (block permutation or iid) and number of resamples (if iid).
GeoLift v2.6.03 (Release date: 2023-04-10)
=========================================
Changes:
* Updated installation instructions.
GeoLift v2.6.02 (Release date: 2023-04-10)
=========================================
Changes:
* Updated documentation to hold S3 methods.
GeoLift v2.6.01 (Release date: 2023-01-11)
=========================================
Changes:
* Fix issue with Lift plot pointwise Confidence Interval calculations.
GeoLift v2.6 (Release date: 2022-11-08)
=========================================
Changes:
* Refactored for loops in run_simulations to adapt to foreach structure.
* Cut down time in GeoLiftPower by 3.5x.
GeoLift v2.5.21 (Release date: 2022-09-16)
=========================================
Changes:
* Added treatment schedule to returning objects from ASCMExecution.
* Fixed TreatmentSchedule plot.
GeoLift v2.5.2 (Release date: 2022-09-16)
=========================================
Changes:
* Refactored GeoLift method into AugsynthExecution to be reused in other functions.
GeoLift v2.5.1 (Release date: 2022-09-16)
=========================================
Changes:
* Added functions to address data replacement in treatment period for continuous GeoLifts.
GeoLift v2.5.0 (Release date: 2022-07-19)
=========================================
Changes:
* Added a Conformal Inference procedure to calculate the Confidence Interval of the Aggregate Lift.
* Added Multi-cell capabilities for GeoLift.
GeoLift v2.4.32 (Release date: 2022-06-10)
=========================================
Changes:
* Added post-treatment analysis capabilities to the GeoLift plot (Lift.plot through the
"post_treatment_periods" parameter.
* Added post-treatment and Region of Practical Equivalence (ROPE) analyses to the ATT plot
(absolute_value.plot).
* Fixed issue with TreatmentSchedule plot.
GeoLift v2.4.31 (Release date: 2022-05-09)
=========================================
Changes:
* When model = "best", we were running one more time augsynth after the best model was chosen.
If we keep all runs in a list and chose the best one best on the l2 scaled criteria,
then we could just call the previous run.
* Simplified and built a loop for the best runs.
* Split GeoLift into two and added print.GeoLift to get the output if the user wants it.
GeoLift v2.4.30 (Release date: 2022-05-09)
=========================================
Changes:
* Added get_market_correlation function using the cor function to get within market correlations faster when dtw=0.
* Removed unnecessary MarketCorrelations function.
GeoLift v2.4.23 (Release date: 2022-04-28)
=========================================
Changes:
* Changed how type of test is displayed from 'TOTAL', 'POSITIVE', 'NEGATIVE' to 'TWO-SIDED LIFT TEST', 'ONE-SIDED POSITIVE LIFT TEST', 'ONE-SIDED NEGATIVE LIFT TEST'
* Changed order of geographies outputted in the synthetic control equation fom alphabetical order to importance by weights
* Simplified summary function by reducing lines of coded needed to handle pasting the confidence interval.
GeoLift v2.4.22 (Release date: 2022-04-21)
=========================================
Changes:
* Avoided duplicated treatment combination of locations with deterministic setups.
* Added locations as a tie-breaker for ranks in GeoLiftMarketSelection().
GeoLift v2.4.21 (Release date: 2022-04-19)
=========================================
Changes:
* Added alpha param within the body of GeoLiftMarketSelection.
GeoLift v2.4.2 (Release date: 2022-04-11)
=========================================
Changes:
* Addressed issues in parallel = FALSE with run_simulations.
GeoLift v2.4.1 (Release date: 2022-04-11)
=========================================
Changes:
* Removed old check of negative and positive effects (which we can support now).
* Changed N condition given length(include_markets) > 0.
GeoLift v2.4.0 (Release date: 2022-04-08)
=========================================
Changes:
* Updated .gitignore.
* Removed large website files (reduced by 250MB).
* Updated Rmd vignette to allow for devtools::check() w/ vignettes.
* Removed parallel computation from MarketSelection to fix parallel issues on Windows systems.
GeoLift v2.3.8 (Release date: 2022-03-31)
=========================================
Changes:
* Remove warning from plot(GeoLiftPower) due to geom_smooth & ylim interaction.
* Remove warning that comes from if condition in limit_test_market.
* Update weights in results object being displayed from GeoLift, kept the augsynth obj, moved df to df_weights.
GeoLift v2.3.7 (Release date: 2022-03-22)
=========================================
Changes:
* Adapted output of stochastic_market_selection to be always the same, regardless of the size of N.
* moved exclude_locations param to `MarketSelection` function.
GeoLift v2.3.6 (Release date: 2022-03-21)
=========================================
Changes:
* Added stop when no combinations that fit criteria are obtained in GeoLiftMarketSelection.
* Skipped iterations when power dataframe returns zero rows.
GeoLift v2.3.5 (Release date: 2022-03-14)
=========================================
Changes:
* Made plot.GeoLiftMarketSelection use plot.GeoLiftPower.
* Aligned nomenclature of all columns across GeoLiftPower & GeoLiftMarketSelection.
* Added side_of_test to plot.GeoLiftMarketSelection to align simulated with test confidence.
GeoLift v2.3.4 (Release date: 2022-03-14)
=========================================
Changes:
* Simplified GeoLiftPowerFinder, GeoLiftPower.search, GeoLiftPower & GeoLiftMarketSelection, unifying the simulation operations under the same method: run_simulations.
GeoLift v2.3.3 (Release date: 2022-03-14)
=========================================
Changes:
* Adapted GeoLiftPower & GeoLiftPower.search to use `lookback_window` hyperparameter replacing `horizon`, which is much less confusing.
GeoLift v2.3.2 (Release date: 2022-03-14)
=========================================
Changes:
* Enabled GeoLiftMarketSelection to go through positive and negative effects, at the same time.
GeoLift v2.3.1 (Release date: 2022-03-14)
=========================================
Changes:
* Simplified code for plot.GeoLiftPower.
* Added hyperparameter to show MDE values.
* Added optional smoothed curve for power.
GeoLift v2.3.0 (Release date: 2022-02-24)
=========================================
Changes:
* Simplified Power Analysis through a single function: GeoLiftMarketSelection().
* To aid in MMM calibrations we included the ability to calculate correlations between test markets and the aggregate of all locations.
* Added investment to the GeoLiftPower output object.
* Revamped the GeoLiftPowerPlot and added legends to the plot.
* Updated the NumberLocations() plot.
* Fixed issues with GeoLift() caused when the input of the locations parameter had special characters.
* Fixed issue with the range of the x axis of GeoPlot() to avoid receiving the warning message: Removed 1 rows containing missing values (geom_vline).
* NumberLocations(), GeoLiftPowerFinder(), and GeoLiftPower.search() are now superseeded by GeoLiftMarketSelection(). We recommend the latter for all power analyses.
* New function GetWeights() returns a dataframe with the weights of the synthetic control model for a given test set-up.
* Added a new plotting function: plotCorrels() to analyze similarities between test and control regions.
GeoLift v2.2.2 (Release date: 2021-02-04)
=========================================
Changes:
* Changed pkg structure.
GeoLift v2.2.1 (Release date: 2021-12-30)
=========================================
Changes:
* Limiting potential test markets to half the amount of available test markets.
GeoLift v2.2.0 (Release date: 2021-12-15)
=========================================
Changes:
* Included lift detected in zero into ranking function for GeoLiftPowerFinder.
GeoLift v2.1.10 (Release date: 2021-12-03)
=========================================
Changes:
* Updated documentation files to match new repository
* Changed devtools for remotes as recommended install method
GeoLift v2.1.9 (Release date: 2021-11-17)
=========================================
Changes:
* Row names from weight matrix were location names. Now they are another column within the matrix.
GeoLift v2.1.8 (Release date: 2021-11-05)
=========================================
Changes:
* Fixed budget filter for inverse/negative Lift in GeoLiftMarketSelection().
* Changed the logic of small pre-treatment warnings in all power calcs. We now recommend having 4x pre-treatment to treatment periods.
* Added the keep_unix_time parameter to GeoDataRead() to keep dates in the data.frame.
GeoLift v2.1.7 (Release date: 2021-10-29)
=========================================
Changes:
* Created the cumulative effect plot in line with our branding guidelines.
GeoLift v2.1.6 (Release date: 2021-10-29)
=========================================
Changes:
* Enhanced the Lift Plot to agree with our branding guidelines.
GeoLift v2.1.5 (Release date: 2021-10-29)
=========================================
Changes:
* Enhanced the ATT Plot to be in agreeable with our branding guidelines. Added incrementality plot as well.
GeoLift v2.1.4 (Release date: 2021-10-22)
=========================================
Changes:
* Adding the GeoLiftMarketSelection() function which provides an option to perform all power calculations in a single step.
GeoLift v2.1.3 (Release date: 2021-10-18)
=========================================
Changes:
* Allows to run one sided and two sided tests in power calculations, by specifying the parameter `side_of_test` in GeoLiftPower, GeoLiftPowerFinder.
GeoLift v2.1.2 (Release date: 2021-10-03)
=========================================
Changes:
* Makes parallelization errors more verbose, by using the `.errorhandling='stop'` option instead of `.errorhandling='remove'` within the `foreach` method.
GeoLift v2.1.1 (Release date: 2021-10-01)
=========================================
Changes:
* Allows to import packages that are not installed on all nodes being used by parallelization, using the `import_augsynth_from` method.