99 design doc plot oc

[audreyyeoCH]

closes #123

new PR as changed remote branch name.

should have been the same PR as here

[danielinteractive]

Also example plot @danielinteractive what do you think ? Colours consistent with plotBetaDiff().

this looks nice!

[danielinteractive]

yes, returning the all_looks as well is a good idea!

[audreyyeoCH]

in addition to amending ocPostprob, I addressed the entire oc series... along with that, for each series :

1. test cases passed ✔️
2. examples worked ✔️
3. helper functions documentation updated for decision i.e. h_get_decision_X, X as per type of oc, required new documentation for orig_nnr ... only did forocPostprob because the others will just inherit it ✔️
4. appropriate asserts added ✔️

[github-actions]

Code Coverage Summary

Filename                 Stmts    Miss  Cover    Missing
---------------------  -------  ------  -------  ----------------------------------
R/betadiff.R                59       0  100.00%
R/boundsPostprob.R          44       0  100.00%
R/boundsPredprob.R          56       1  98.21%   83
R/dbetabinom.R              81       3  96.30%   32, 62, 136
R/oc2.R                    162     162  0.00%    93-326
R/oc3.R                    146     146  0.00%    91-308
R/ocPostprob.R             117       6  94.87%   255-260
R/ocPostprobDist.R         122       0  100.00%
R/ocPredprob.R             205       6  97.07%   300-305
R/ocPredprobDist.R         257       5  98.05%   363-367
R/ocRctPostprobDist.R      166       6  96.39%   241-246
R/ocRctPredprobDist.R      302      60  80.13%   214-230, 233-249, 385-390, 421-440
R/plotBeta.R                71       5  92.96%   115-119
R/plotBounds.R              52      52  0.00%    33-90
R/plotDecision.R            79      79  0.00%    16-136
R/plotOc.R                  21      21  0.00%    16-46
R/postprob.R                34       1  97.06%   106
R/postprobDist.R            77       1  98.70%   204
R/predprob.R                24       0  100.00%
R/predprobDist.R           140       1  99.29%   269
R/runShinyPhase1b.R          4       4  0.00%    8-13
R/sumbetadiff.R             63      63  0.00%    24-101
R/sumTable.R                20      20  0.00%    25-48
TOTAL                     2302     642  72.11%

Diff against main

Filename                 Stmts    Miss  Cover
---------------------  -------  ------  --------
R/boundsPredprob.R         +28     -27  +98.21%
R/ocPostprob.R             +18      +2  -1.09%
R/ocPostprobDist.R         +13       0  +100.00%
R/ocPredprob.R             +23      +2  -0.73%
R/ocPredprobDist.R         +22      +2  -0.67%
R/ocRctPostprobDist.R      +12      +2  -1.02%
R/ocRctPredprobDist.R      +19      +5  -0.43%
R/plotBeta.R               -32     -85  +80.34%
R/plotOc.R                  +6      +6  +100.00%
R/predprobDist.R            -1       0  -0.01%
TOTAL                     +108     -93  +5.61%

Results for commit: eb0a855

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

    1 files     16 suites   3m 44s ⏱️
  121 tests   120 ✅ 1 💤 0 ❌
1 270 runs  1 269 ✅ 1 💤 0 ❌

Results for commit eb0a855.

♻️ 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$
ocPredprobDist	💔	$48.97$	$+116.63$	$0$	$0$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
ocPredprobDist	💔	$12.73$	$+26.18$	ocPredprobDist_gives_correct_result_and_list_when_relativeDelta_FALSE
ocPredprobDist	💔	$13.19$	$+31.22$	ocPredprobDist_gives_correct_result_and_list_when_relativeDelta_TRUE
ocPredprobDist	💔	$5.17$	$+18.55$	ocPredprobDist_gives_higher_PrEfficacy_with_more_efficacy_looks
ocPredprobDist	💔	$17.86$	$+40.68$	ocPredprobDist_gives_higher_PrFutility_with_more_futility_looks
ocRctPredprobDist	💀	$0.02$	$-0.02$	h_decision_two_RctPredProbDist_gives_correct_result_and_list_when_relativeDelta_FALSE
ocRctPredprobDist	💀	$0.02$	$-0.02$	h_decision_two_RctPredProbDist_gives_correct_result_and_list_when_relativeDelta_TRUE
ocRctPredprobDist	👶		$+0.02$	h_decision_two_RctpredprobDist_gives_correct_result_and_list_when_relativeDelta_FALSE
ocRctPredprobDist	👶		$+0.02$	h_decision_two_RctpredprobDist_gives_correct_result_and_list_when_relativeDelta_TRUE

Results for commit c1fc01d

♻️ This comment has been updated with latest results.

[danielinteractive]

thanks @audreyyeoCH , that is a lot of changes for a design doc PR 😆 but I guess you needed the adaptations to make the design work. sounds good

[audreyyeoCH]

thanks @audreyyeoCH , that is a lot of changes for a design doc PR 😆 but I guess you needed the adaptations to make the design work. sounds good

thanks @danielinteractive, haha agree. It was confusing to know because the examples used a different oc series to what the documentation said it was for. I asked this Q in one of the conversations above. I figured, should be for all oc !