-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add tutorial 2 and fixed some minor typo in docs
- Loading branch information
Showing
6 changed files
with
93 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
include requirements.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
## xltoy tutorial | ||
Here are some examples useful to understand use cases. All used files are | ||
available in this repository. | ||
|
||
#### case1: values diff on simple model | ||
|
||
In this example, we compare 2 workbook with only 1 data range each one. | ||
Working area is set only on numeric cells, so we can do positional difference. | ||
In second workbook we have add a new line, row 12 corresponding to VAR_9 | ||
and changed a cell in position M7. | ||
|
||
![xlsample](https://github.com/glaucouri/xltoy/raw/main/img/data_sample1.png?raw=true) | ||
![xlsample](https://github.com/glaucouri/xltoy/raw/main/img/data_sample1_diff.png?raw=true) | ||
|
||
``` | ||
(xltoy)$ xltoy diff data/data_sample1.xlsx data/data_sample1_diff.xlsx | ||
add: | ||
D12: 0.0005004366657703548 | ||
E12: 0.000547121974635698 | ||
F12: 0.0005295198569146752 | ||
G12: 0.0005072172479631228 | ||
H12: 0.0005379024723558388 | ||
I12: 0.0005430174783953075 | ||
J12: 0.0005689182087171011 | ||
K12: 0.0005538596087349697 | ||
L12: 0.0005297508191981888 | ||
M12: 0.0005409815166305603 | ||
N12: 0.0005876844243079103 | ||
O12: 0.0006204197757602877 | ||
P12: 0.0006232399068120899 | ||
Q12: 0.0007001965787723482 | ||
R12: 0.0007432987416372932 | ||
S12: 0.0007323677326847715 | ||
change: | ||
data_sample: | ||
M7: 905509 -> 905510 | ||
``` | ||
|
||
#### case2: values diff on simple model [positional relative] | ||
|
||
First workbook is from case1 | ||
In second workbook range was moved to another position | ||
|
||
![xlsample](https://github.com/glaucouri/xltoy/raw/main/img/data_sample1_relative.png?raw=true) | ||
|
||
``` | ||
(xltoy)$ xltoy diff data/data_sample1.xlsx data/data_sample1_relative.xlsx --relative | ||
<no output> | ||
``` | ||
|
||
So in relative mode, no difference found | ||
|
||
|
||
|
||
#### case 3: collecting formula on anonymous model | ||
|
||
This is an example of a common forecasting model that can be well handled by XLtoy. | ||
![xlsample](https://github.com/glaucouri/xltoy/raw/main/img/simple_model.png?raw=true) | ||
Green cells contain actual (or hystorical) values, model in salmon for the first calculated step, | ||
and in yellow dragged cells, the rest of the model. As you can see in the outcome, | ||
no labels are provided in the input so the collector assign to each formula a label anon_1,2,3,..,n | ||
|
||
``` | ||
(xltoy)$ xltoy collect data/anon_sheet.xlsx --yaml | ||
WAR Found anonymous model Sheet1 : 11 anon labels assigned | ||
Sheet1: | ||
anon_1: =(E3+D3)/2 | ||
anon_10: =LOG(F11) | ||
anon_11: =LOG($F$11) | ||
anon_2: =(E4+D4)/2 | ||
anon_3: =(E5+D5)/2 | ||
anon_4: =(E6+D6)/2 | ||
anon_5: =IF(D7,D7+E7,D7-E7) | ||
anon_6: =RAND() | ||
anon_7: =E9*0.023 | ||
anon_8: =8 | ||
anon_9: =12 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters