Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove backticks around CDISC and ADaM #257

Merged
merged 12 commits into from
Feb 5, 2024
Merged

Conversation

gogonzo
Copy link
Contributor

@gogonzo gogonzo commented Jan 19, 2024

m7pr and others added 3 commits January 18, 2024 11:54
@gogonzo gogonzo added the core label Jan 19, 2024
Copy link
Contributor

github-actions bot commented Jan 19, 2024

badge

Code Coverage Summary

Filename                         Stmts    Miss  Cover    Missing
-----------------------------  -------  ------  -------  --------------------
R/cdisc_data.R                       1       0  100.00%
R/deprecated.R                      57      57  0.00%    19-344
R/dummy_function.R                   2       2  0.00%    14-15
R/formatters_var_labels.R           36      11  69.44%   60, 69-80
R/join_key.R                        38       0  100.00%
R/join_keys-c.R                     12       0  100.00%
R/join_keys-extract.R              128       0  100.00%
R/join_keys-names.R                 15       0  100.00%
R/join_keys-parents.R               30       0  100.00%
R/join_keys-print.R                 45       0  100.00%
R/join_keys-utils.R                 73       3  95.89%   35-38
R/join_keys.R                       21       0  100.00%
R/teal_data-class.R                 25       1  96.00%   69
R/teal_data-datanames.R             10       0  100.00%
R/teal_data-get_code.R              14       0  100.00%
R/teal_data-show.R                   4       4  0.00%    14-19
R/teal_data.R                       30      16  46.67%   34, 37-43, 53-59, 62
R/testhat-helpers.R                 26       0  100.00%
R/topological_sort.R                32       0  100.00%
R/utils-get_code_dependency.R      170       1  99.41%   268
R/verify.R                          42      11  73.81%   63, 93-97, 100-104
TOTAL                              811     106  86.93%

Diff against main

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

Results for commit: 2d9fc71

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Contributor

github-actions bot commented Jan 19, 2024

Unit Tests Summary

  1 files   14 suites   1s ⏱️
175 tests 173 ✅ 2 💤 0 ❌
245 runs  243 ✅ 2 💤 0 ❌

Results for commit 2d9fc71.

♻️ This comment has been updated with latest results.

@m7pr
Copy link
Contributor

m7pr commented Jan 19, 2024

I'm voting opposite towards this card. In this issue https://github.com/insightsengineering/coredev-tasks/issues/235 we decided to put ticks around all data models and convention names in all our packages.

@m7pr
Copy link
Contributor

m7pr commented Jan 19, 2024

ADaM has backticks in all 25 packages, not just in teal.

@m7pr
Copy link
Contributor

m7pr commented Jan 19, 2024

Hey, can you have a look at the motivation for including backticks for CDISC and ADaM insightsengineering/goshawk#197 (comment)

If you remove backticks in here, can you also remove in teal.slice, teal.transform, teal.code, teal.data, teal.logger, teal.widgets, teal.modules.general, teal.modules.clinical, goshawk , tern , tern.mmrm, osprey , teal.goshawk, teal.osprey, hermes, teal.modules.hermes, helios, teal.modules.helios, chevron, formatters, dunlin, citril, rtables.

If you decide to remove backtick for CDISC and ADaM, can you also consider removing them for all other data structures like ARM or ADSL

@chlebowa
Copy link
Contributor

chlebowa commented Jan 19, 2024

Not teal.code, surely 🤨 🧐

Copy link
Contributor

@m7pr m7pr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey blocking just in case until we align if we really need this

@donyunardi donyunardi mentioned this pull request Jan 22, 2024
33 tasks
@donyunardi
Copy link
Contributor

From https://github.com/insightsengineering/coredev-tasks/issues/492#issuecomment-1901202835

But "CDISC" and "ADaM" are a bit different in that they are really just acronyms, and it's unlikely that they are used directly as name of data objects/parameters. So removing backticks make more sense to me.
As this backtick usage permeate across all NEST package, I will discuss and align on a decision with other POs.

Blocking this PR for now until we hear more from @lcd2yyz
However, this shouldn't a blocker for release.

@m7pr m7pr removed the blocked label Feb 5, 2024
@m7pr
Copy link
Contributor

m7pr commented Feb 5, 2024

In here we decided no to quote ADaM and CDISC/DISC acronyms insightsengineering/teal.modules.clinical#1017

Will fix conflicts and merge this branch

m7pr added 2 commits February 5, 2024 12:14
Merge branch 'main' into remove_backticks_cdisc@main

# Conflicts:
#	R/default_cdisc_join_keys.R
#	man/build_cdisc_join_keys.Rd
#	man/default_cdisc_join_keys.Rd
@m7pr m7pr enabled auto-merge (squash) February 5, 2024 11:18
@m7pr m7pr merged commit 09bb886 into main Feb 5, 2024
24 checks passed
@m7pr m7pr deleted the remove_backticks_cdisc@main branch February 5, 2024 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants