insightsengineering / teal.osprey

Community efforts to collect teal modules for TLGs defined in the osprey package
https://insightsengineering.github.io/teal.osprey/
Other
5 stars 2 forks source link

78 simplify joinkeys@main #233

Closed chlebowa closed 10 months ago

chlebowa commented 10 months ago

Closes #231

Modified example apps to use the following pattern:

  1. create cdisc_data
  2. use within to evaluate code
  3. set datanames manually (enumerate datasets)
  4. set join keys automatically with default_cdisc_join_keys[datanames(data)]
  5. assign datasets in global where applicable
  6. create app
  7. run app

Removed all package prefixes in examples.

github-actions[bot] commented 10 months ago

badge

Code Coverage Summary

Filename                    Stmts    Miss  Cover    Missing
------------------------  -------  ------  -------  --------------
R/tm_g_ae_oview.R             249     249  0.00%    83-365
R/tm_g_ae_sub.R               318     318  0.00%    59-413
R/tm_g_butterfly.R            387     387  0.00%    124-551
R/tm_g_decorate.R              46      46  0.00%    18-98
R/tm_g_events_term_id.R       298     298  0.00%    63-399
R/tm_g_heat_bygrade.R         320     320  0.00%    135-490
R/tm_g_patient_profile.R      710     710  0.00%    159-934
R/tm_g_spiderplot.R           323     323  0.00%    99-467
R/tm_g_swimlane.R             377     377  0.00%    125-559
R/tm_g_waterfall.R            424     424  0.00%    108-583
R/utils.R                      37      32  13.51%   32-91, 124-131
R/zzz.R                         1       1  0.00%    2
TOTAL                        3490    3485  0.14%

Diff against main

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

Results for commit: 9fe3de1337969e49c9452cc558d4d9e233812b5c

Minimum allowed coverage is 80%

:recycle: This comment has been updated with latest results

github-actions[bot] commented 10 months ago

Unit Tests Summary

  1 files    1 suites   0s :stopwatch:   4 tests   4 :heavy_check_mark: 0 :zzz: 0 :x: 13 runs  13 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 9fe3de13.

:recycle: This comment has been updated with latest results.

m7pr commented 10 months ago

Hey, so far looks good. I will pull it locally, install and check, just in case

m7pr commented 10 months ago

@chlebowa should we bump version for teal.data in DESCRIPTION file?

chlebowa commented 10 months ago

Good point :+1:

m7pr commented 10 months ago

Any NEWS update like in here? https://github.com/insightsengineering/teal.modules.general/pull/597/files#diff-51920e95310ebfbc1ae31709f3b95f89afffbf4f1a6e38e8b2b406e2fb6197ea

chlebowa commented 10 months ago

I'm not sure, honestly. We usually only mention user-facing changes, meaning interface changes. This is just an adjustment to the larger refactor in teal.data.

m7pr commented 10 months ago

I'm not sure, honestly. We usually only mention user-facing changes, meaning interface changes. This is just an adjustment to the larger refactor in teal.data.

I think it's useful information for the user to know that examples changed, because we have a new way of specyfing teal_data, hence it's useful to put in NEWS because of that.

chlebowa commented 10 months ago

Any NEWS update like in here? https://github.com/insightsengineering/teal.modules.general/pull/597/files#diff-51920e95310ebfbc1ae31709f3b95f89afffbf4f1a6e38e8b2b406e2fb6197ea

That's not an enhancement...

chlebowa commented 10 months ago

@chlebowa should we bump version for teal.data in DESCRIPTION file?

What number, though? main doesn't have the changes yet, so the pipeline will fail and the feature branch has the same version number as main because the bump occurs on merge, so the pipeline will fail.

m7pr commented 10 months ago

Any NEWS update like in here? https://github.com/insightsengineering/teal.modules.general/pull/597/files#diff-51920e95310ebfbc1ae31709f3b95f89afffbf4f1a6e38e8b2b406e2fb6197ea

That's not an enhancement...

The way we specify data in the whole framework changed, so I think it's relevant to inform users about this change in all packages dependent on teal.data. This is a propagation of a feature from the dependent package that made us update examples. Does not hurt