52 standardise optional notation

[kartikeyakirar]

part of insightsengineering/nestdevs-tasks#52

• standardise optional notation
• updated roxygen tags

[github-actions]

Unit Tests Summary

 1 files   1 suites   0s ⏱️
 4 tests  4 ✅ 0 💤 0 ❌
13 runs  13 ✅ 0 💤 0 ❌

Results for commit 12ffdfa.

♻️ This comment has been updated with latest results.

[github-actions]

Code Coverage Summary

Filename                    Stmts    Miss  Cover    Missing
------------------------  -------  ------  -------  --------------
R/tm_g_ae_oview.R             252     252  0.00%    83-368
R/tm_g_ae_sub.R               315     315  0.00%    59-410
R/tm_g_butterfly.R            388     388  0.00%    124-552
R/tm_g_decorate.R              46      46  0.00%    18-98
R/tm_g_events_term_id.R       299     299  0.00%    63-400
R/tm_g_heat_bygrade.R         322     322  0.00%    135-493
R/tm_g_patient_profile.R      711     711  0.00%    157-933
R/tm_g_spiderplot.R           324     324  0.00%    99-468
R/tm_g_swimlane.R             376     376  0.00%    124-557
R/tm_g_waterfall.R            427     427  0.00%    108-586
R/utils.R                      37      32  13.51%   32-91, 124-131
R/zzz.R                         1       1  0.00%    2
TOTAL                        3498    3493  0.14%

Diff against main

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

Results for commit: 12ffdfa

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[m7pr]

Hey, added a couple of cleanups to README, DESCRIPTION and R/teal.osprey.R then were overdue. Those would be required anyway.

Other than that this is ready to be merged. Great job.

[kartikeyakirar]

@m7pr document inherit description from teal.widgets. so this needs to be merged and re-triggered checks after insightsengineering/teal.widgets#231 is merged.

[m7pr]

Yes, I noticed. Feel free to merge insightsengineering/teal.widgets#231
then rebuild docs in here. And then merge this one.