Update README.md

[ckalyvas]

First draft of the README file

[github-actions]

Code Coverage Summary

Filename               Stmts    Miss  Cover    Missing
-------------------  -------  ------  -------  -----------------------------------------------------------------------------------
R/binary-helper.R         59       7  88.14%   14, 18, 21, 24, 28, 31, 36
R/bootstrap.R             23      23  0.00%    54-88
R/bucher.R                55       3  94.55%   103, 107, 111
R/data_generation.R       20      20  0.00%    36-73
R/maic_anchored.R        177      34  80.79%   65-72, 77-80, 84, 87, 91, 94-97, 100-103, 108-109, 113, 116, 138-143, 163, 223, 229
R/maic_unanchored.R      253      33  86.96%   77-84, 87-88, 93, 96-99, 102-105, 110, 120, 123, 146-153, 182, 239, 246, 355, 362
R/matching.R             245     146  40.41%   65, 70-72, 77-80, 87-94, 139, 175, 214, 256-516
R/plot_km.R              449     373  16.93%   46-598
R/plot_km2.R             107      22  79.44%   50, 59, 62, 65, 87-93, 120-128, 131, 175
R/process_data.R         101      44  56.44%   49-51, 56, 71-74, 80, 92-93, 183, 216-280
R/reporting.R             59       1  98.31%   91
R/survival-helper.R       30       3  90.00%   63, 66-67
R/time-helper.R            9       4  55.56%   22, 37-38, 52
R/utils.R                 12      10  16.67%   4, 11-20
R/zzz.R                    1       1  0.00%    2
TOTAL                   1600     724  54.75%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: d51eaf7

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

 1 files   7 suites   6s ⏱️
22 tests 21 ✅ 1 💤 0 ❌
71 runs  68 ✅ 3 💤 0 ❌

Results for commit d51eaf7.