Vignette for correlation(PFS, OS)

[holgstr]

Adds vignette to describe how cor(PFS, OS) is computed & how parameters are estimated.

[danielinteractive]

Thanks @holgstr , looks nice to me on first browse - @numbersman77 maybe you can review in detail?

[github-actions]

Code Coverage Summary

Filename                     Stmts    Miss  Cover    Missing
-------------------------  -------  ------  -------  ----------------------
R/assertions.R                  15       0  100.00%
R/corPFSOS.R                    91      37  59.34%   34-53, 92-113, 303-321
R/empSignificant.R              59       0  100.00%
R/estimateParams.R              75       4  94.67%   138-141
R/eventTracking.R               88       2  97.73%   48, 244
R/getClinicalTrials.R           71       0  100.00%
R/getSimulatedData.R           109       0  100.00%
R/getWaitTimeSum.R              29       2  93.10%   45, 48
R/hazardFunctions.R             26       0  100.00%
R/piecewiseDistribution.R       32       0  100.00%
R/piecewiseHazards.R            18       0  100.00%
R/survivalFunctions.R          111       0  100.00%
R/transitionParameters.R        42       0  100.00%
TOTAL                          766      45  94.13%

Diff against main

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

Results for commit: 94b1908

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Test Performance Difference

Test Suite	$Status$	Time on main	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
getSimulatedDataDistib	💔	$97.59$	$+3.09$	$0$	$0$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
getSimulatedDataDistib	💔	$35.08$	$+1.35$	getSimulatedData_generates_distributions_as_expected_PW
getSimulatedDataDistib	💔	$50.95$	$+1.36$	getSimulatedData_generates_distributions_as_expected_Weibull

Results for commit 70cb380

♻️ This comment has been updated with latest results.

[github-actions]

Unit Tests Summary

    1 files    16 suites   2m 12s ⏱️
  81 tests   80 ✔️ 1 💤 0 ❌
185 runs  184 ✔️ 1 💤 0 ❌

Results for commit 94b1908.

♻️ This comment has been updated with latest results.

[holgstr]

@danielinteractive this implements Kaspar's feedback, including his suggestion to rename bootstrap_level to conf_level.