Try roxylint with modified linter behavior for param/typed

[danielinteractive]

Trying to follow instructions in https://github.com/openpharma/roxylint - but somehowI don't get the modified behavior and no longer check sentence case for param or typed, but I am still seeing sentence case warnings. Here an excerpt from the "Document" log:

ℹ [settings.R:1] @title should be 'Sentence case'.
Found improperly cased word(s): 'jmpost'
ℹ [simulate.R:1] @title should be 'Sentence case'.
Found improperly cased word(s): 'Patients', 'Posterior', 'Predictive', 'Distribution'
ℹ [simulate.R:2] @param should terminate with a full stop
ℹ [simulate.R:12] @typed should be 'Sentence case'
ℹ [simulate.R:14] @typed should be 'Sentence case'
ℹ [simulate.R:16] @typed should be 'Sentence case'
ℹ [simulate.R:140] @param should terminate with a full stop
ℹ [simulate.R:141] @param should terminate with a full stop
ℹ [standalone-s3-register.R:47] @param should terminate with a full stop

[github-actions]

Code Coverage Summary

Filename                           Stmts    Miss  Cover    Missing
-------------------------------  -------  ------  -------  ------------------------------
R/brier_score.R                      173       1  99.42%   272
R/DataJoint.R                         78       0  100.00%
R/DataLongitudinal.R                 126       1  99.21%   251
R/DataSubject.R                       85       1  98.82%   144
R/DataSurvival.R                     101       0  100.00%
R/defaults.R                          13       9  30.77%   17-59, 86
R/generics.R                          36       5  86.11%   53, 391, 412, 475, 493
R/Grid.R                              27       1  96.30%   183
R/GridEven.R                          36       0  100.00%
R/GridEvent.R                         22       0  100.00%
R/GridFixed.R                         30       0  100.00%
R/GridGrouped.R                       54       0  100.00%
R/GridManual.R                        23       3  86.96%   79-81
R/GridObserved.R                      24       0  100.00%
R/GridPopulation.R                    37       4  89.19%   66, 74-76
R/GridPrediction.R                    37       6  83.78%   85, 93-97
R/JointModel.R                       131       9  93.13%   148-153, 203, 207, 252, 325
R/JointModelSamples.R                 81       0  100.00%
R/link_generics.R                     39      16  58.97%   67-70, 93-96, 115-118, 141-144
R/Link.R                              66       4  93.94%   202-205
R/LinkComponent.R                     24       3  87.50%   92, 121-122
R/LongitudinalClaretBruno.R          122       6  95.08%   219-223, 242
R/LongitudinalGSF.R                  137       0  100.00%
R/LongitudinalModel.R                 20       0  100.00%
R/LongitudinalQuantities.R            74       0  100.00%
R/LongitudinalRandomEffects.R         65      17  73.85%   86-111
R/LongitudinalRandomSlope.R           60       6  90.00%   132-136, 149
R/LongitudinalSteinFojo.R            116      10  91.38%   202-206, 245-249
R/Parameter.R                         14       0  100.00%
R/ParameterList.R                     42       1  97.62%   188
R/populationHR.R                      63       0  100.00%
R/Prior.R                            279       6  97.85%   590, 739-753
R/Promise.R                           29       0  100.00%
R/Quantities.R                        61       0  100.00%
R/QuantityGeneratorPopulation.R       23       0  100.00%
R/QuantityGeneratorPrediction.R       48       0  100.00%
R/QuantityGeneratorSubject.R          21       0  100.00%
R/settings.R                          12      12  0.00%    51-65
R/SimGroup.R                           5       0  100.00%
R/SimJointData.R                     180      10  94.44%   133, 300-308
R/SimLongitudinal.R                    5       2  60.00%   22, 41
R/SimLongitudinalClaretBruno.R       107       0  100.00%
R/SimLongitudinalGSF.R               107       0  100.00%
R/SimLongitudinalRandomSlope.R        50       0  100.00%
R/SimLongitudinalSteinFojo.R          77       0  100.00%
R/SimSurvival.R                      165       0  100.00%
R/simulate.R                         364     364  0.00%    41-543
R/StanModel.R                         16       0  100.00%
R/StanModule.R                       186       6  96.77%   202-203, 247, 258, 409, 437
R/SurvivalExponential.R               14       0  100.00%
R/SurvivalGamma.R                     17       0  100.00%
R/SurvivalLoglogistic.R               15       0  100.00%
R/SurvivalModel.R                     20       0  100.00%
R/SurvivalQuantities.R               172       1  99.42%   127
R/SurvivalWeibullPH.R                 25       0  100.00%
R/utilities.R                        149       2  98.66%   15, 351
R/zzz.R                               31      28  9.68%    3-7, 9-32, 39-48
TOTAL                               4134     534  87.08%

Diff against main

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

Results for commit: f25e8ed

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

    1 files    191 suites   7m 1s ⏱️
  169 tests   154 ✅ 15 💤 0 ❌
1 133 runs  1 117 ✅ 16 💤 0 ❌

Results for commit 16243e7.

♻️ 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$
LongitudinalRandomEffects	💚	$93.29$	$-36.05$	$0$	$0$	$0$	$0$
compile	💚	$7.78$	$-1.60$	$0$	$0$	$0$	$0$
extract_quantities	💚	$9.04$	$-8.99$	$0$	$0$	$0$	$0$
misc_models	💚	$15.40$	$-7.26$	$0$	$0$	$0$	$0$
model_multi_chain	💚	$61.44$	$-51.23$	$0$	$0$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
Grid	💚	$112.85$	$-70.57$	Grid_objects_work_with_QuantityGenerator_and_QuantityCollapser
GridPrediction	💚	$119.64$	$-5.46$	GridPrediction_works_as_expected_for_Survival_models
JointModelSamples	💔	$11.68$	$+21.75$	print_works_as_expected_for_JointModelSamples
LongitudinalClaretBruno	💚	$1828.17$	$-1821.19$	LongitudinalClaretBruno_works_as_expected_with_default_arguments
LongitudinalGSF	💚	$1885.77$	$-1877.60$	LongitudinalGSF_works_as_expected_with_default_arguments
LongitudinalQuantiles	💚	$48.05$	$-37.72$	Test_that_LongitudinalQuantities_works_as_expected
LongitudinalRandomEffects	💚	$93.28$	$-36.05$	LongitudinalRandomEffects_works_as_expected
LongitudinalRandomSlope	💚	$76.62$	$-72.30$	Print_method_for_LongitudinalRandomSlope_works_as_expected
LongitudinalSteinFojo	💚	$1800.85$	$-1799.36$	LongitudinalSteinFojo_works_as_expected_with_default_arguments
SimSurvival	💚	$4.51$	$-4.14$	SimSurvivalExponential_creates_a_dataset_with_the_correct_parameter
SurvivalExponential	💚	$33.49$	$-32.35$	Can_load_and_compile_SurvivalExponential_model
SurvivalGamma	💚	$206.59$	$-205.92$	Print_method_for_SurvivalGamma_works_as_expected
SurvivalLoglogistic	💚	$42.70$	$-41.76$	Can_load_and_compile_SurvivalLogLogistic_model
SurvivalQuantities	💚	$97.96$	$-41.25$	SurvivalQuantities_and_autoplot.SurvivalQuantities_works_as_expected
SurvivalWeibullPH	💚	$14.70$	$-13.17$	Print_method_for_SurvivalWeibullPH_works_as_expected
brierScore	💚	$67.17$	$-62.20$	brierScore_SurvivalQuantities_returns_same_results_as_survreg
brms_compare	💚	$362.37$	$-362.30$	jmpost_and_brms_get_similar_loo_for_longitudinal_models
compile	💚	$7.78$	$-1.60$	compileStanModel_doesn_t_error_if_the_directory_doesn_t_exist
extract_quantities	💚	$9.04$	$-8.99$	extract_quantities_works_as_expected
initialValues	💚	$2.81$	$-1.04$	initialValues_works_as_expected
misc_models	💚	$15.40$	$-7.26$	Longitudinal_Model_doesn_t_print_sampler_rejection_messages
model_multi_chain	💚	$61.44$	$-51.23$	Can_recover_known_distribution_parameters_from_random_slope_model_when_using_multiple_chains
populationHR	💚	$30.02$	$-11.43$	populationHR_works_as_expected_for_default_parameters
simulate	💚	$394.18$	$-394.06$	simulate_works_with_default_options
stan_functions	💚	$41.01$	$-26.98$	GSF_SLD_function_works_as_expected

Results for commit 0d8a755

♻️ This comment has been updated with latest results.