Add saveObject function

[gowerc]

Closes #431

Added wrapper saveObject() method that takes care of ensuring the samples are correctly saving along with the object.

[github-actions]

Code Coverage Summary

Filename                           Stmts    Miss  Cover    Missing
-------------------------------  -------  ------  -------  --------------------------------
R/brier_score.R                      167       0  100.00%
R/DataJoint.R                         76       2  97.37%   264, 270
R/DataLongitudinal.R                 119       1  99.16%   244
R/DataSubject.R                       85       1  98.82%   142
R/DataSurvival.R                      98       0  100.00%
R/defaults.R                          10       6  40.00%   18-57, 84
R/generics.R                          34       4  88.24%   52, 382, 402, 457
R/Grid.R                              27       1  96.30%   173
R/GridEven.R                          32       0  100.00%
R/GridEvent.R                         22       0  100.00%
R/GridFixed.R                         30       0  100.00%
R/GridGrouped.R                       52       0  100.00%
R/GridManual.R                        23       3  86.96%   78-80
R/GridObserved.R                      20       0  100.00%
R/GridPopulation.R                    31       4  87.10%   61, 69-71
R/GridPrediction.R                    36       6  83.33%   83, 91-95
R/JointModel.R                       129      10  92.25%   148-153, 203, 207, 249, 295, 301
R/JointModelSamples.R                 71       0  100.00%
R/link_generics.R                     16       4  75.00%   59, 76, 91, 106
R/Link.R                              62       4  93.55%   200-203
R/LinkComponent.R                     19       3  84.21%   88, 120-121
R/LongitudinalClaretBruno.R           90       6  93.33%   168-172, 187
R/LongitudinalGSF.R                   95       0  100.00%
R/LongitudinalModel.R                 19       0  100.00%
R/LongitudinalQuantities.R            71       0  100.00%
R/LongitudinalRandomSlope.R           44       5  88.64%   102-106
R/LongitudinalSteinFojo.R             86       5  94.19%   159-163
R/Parameter.R                         14       0  100.00%
R/ParameterList.R                     42       1  97.62%   184
R/Prior.R                            270       6  97.78%   547, 691-705
R/Promise.R                           25       0  100.00%
R/Quantities.R                        60       0  100.00%
R/QuantityGeneratorPopulation.R       22       0  100.00%
R/QuantityGeneratorPrediction.R       48       0  100.00%
R/QuantityGeneratorSubject.R          19       0  100.00%
R/settings.R                          12      12  0.00%    55-69
R/SimGroup.R                           5       0  100.00%
R/SimJointData.R                      72       1  98.61%   103
R/SimLongitudinal.R                    5       2  60.00%   22, 40
R/SimLongitudinalClaretBruno.R        74       0  100.00%
R/SimLongitudinalGSF.R                80       0  100.00%
R/SimLongitudinalRandomSlope.R        42       0  100.00%
R/SimLongitudinalSteinFojo.R          69       0  100.00%
R/SimSurvival.R                      116       0  100.00%
R/StanModel.R                         15       0  100.00%
R/StanModule.R                       176       6  96.59%   192-193, 235, 246, 383, 411
R/SurvivalExponential.R               10       0  100.00%
R/SurvivalGamma.R                     13       0  100.00%
R/SurvivalLoglogistic.R               11       0  100.00%
R/SurvivalModel.R                     19       0  100.00%
R/SurvivalQuantities.R               170       1  99.41%   125
R/SurvivalWeibullPH.R                 13       0  100.00%
R/utilities.R                        144       2  98.61%   13, 335
R/zzz.R                               29      26  10.34%   4-8, 10-31, 38-47
TOTAL                               3139     122  96.11%

Diff against main

Filename                 Stmts    Miss  Cover
---------------------  -------  ------  --------
R/generics.R                +1       0  +0.36%
R/JointModelSamples.R       +5       0  +100.00%
TOTAL                       +6       0  +0.01%

Results for commit: 7686e68

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$
JointModelSamples	💚	$30.63$	$-30.63$	$+2$	$0$	$0$	$0$
compile	💔	$4.35$	$+1.61$	$0$	$0$	$0$	$0$
extract_quantities	💚	$1.59$	$-1.58$	$0$	$0$	$0$	$0$
misc_models	💔	$6.66$	$+1.10$	$0$	$0$	$0$	$0$
model_multi_chain	💔	$0.01$	$+28.52$	$0$	$0$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
Grid	💚	$45.57$	$-2.43$	Grid_objects_work_with_QuantityGenerator_and_QuantityCollapser
GridPrediction	💚	$121.70$	$-3.89$	GridPrediction_works_as_expected_for_Survival_models
JointModelSamples	💔	$30.63$	$+1.22$	print_works_as_expected_for_JointModelSamples
JointModelSamples	👶		$+0.01$	saving_and_restoring_samples_from_disk_works_as_expected
LongitudinalRandomSlope	💚	$23.28$	$-2.03$	Print_method_for_LongitudinalRandomSlope_works_as_expected
brierScore	💚	$2.93$	$-1.94$	brierScore_SurvivalQuantities_returns_same_results_as_survreg
compile	💔	$4.35$	$+1.61$	compileStanModel_doesn_t_error_if_the_directory_doesn_t_exist
extract_quantities	💚	$1.59$	$-1.58$	extract_quantities_works_as_expected
misc_models	💔	$6.66$	$+1.10$	Longitudinal_Model_doesn_t_print_sampler_rejection_messages
model_multi_chain	💔	$0.01$	$+28.52$	Can_recover_known_distribution_parameters_from_random_slope_model_when_using_multiple_chains
stan_functions	💚	$30.20$	$-30.14$	GSF_SLD_function_works_as_expected

Results for commit 03a68c1

♻️ This comment has been updated with latest results.

[danielinteractive]

Looks great, thanks @gowerc , would it be worth to add a NEWS entry?

[gowerc]

@danielinteractive - Good point, though I took this moment to add all the missing news items that I had neglected to add over the last couple of PRs 😓

[danielinteractive]

Nice! Thanks @gowerc

[github-actions]

Unit Tests Summary

    1 files    180 suites   5m 43s ⏱️
  158 tests   146 ✅ 12 💤 0 ❌
1 101 runs  1 088 ✅ 13 💤 0 ❌

Results for commit 7686e68.

♻️ This comment has been updated with latest results.