Skip to content

Closes #80 Align core attribute documentation with ADaM IG 1.3 and SDTM standards - #127

Merged
bms63 merged 5 commits into
80-documentation-core-in-readmefrom
copilot/update-readme-core-values
Dec 9, 2025
Merged

Closes #80 Align core attribute documentation with ADaM IG 1.3 and SDTM standards#127
bms63 merged 5 commits into
80-documentation-core-in-readmefrom
copilot/update-readme-core-values

Conversation

Copilot AI commented Nov 24, 2025

Copy link
Copy Markdown

The documentation incorrectly listed "Expected" and "Conditionally Expected" as valid ADaM core values. Per ADaM IG 1.3 pg 14, ADaM only uses: Required, Conditionally Required, and Permissible.

Changes

  • README.Rmd/README.md: Updated core attribute description in ds_vars table to specify:
    • ADaM IG 1.3: "Required", "Conditionally Required", "Permissible"
    • SDTM: "Required", "Expected", "Permissible"
  • Building_Specification_Readers.Rmd: Added standard-specific core values

Scope

Validation logic in R/validators.R unchanged to avoid breaking existing metadata that may use the broader set of values.

Original prompt

This section details on the original issue you should resolve

<issue_title>Documentation: core in Readme</issue_title>
<issue_description>image

In ADaM IG, core can be Required, Conditionally required or Permissible (ADAM IG 1.3 pg 14)
image

SDTM IG 3.4 page 22
image

It is not clear what core values are allowed. Furthermore, in CDISC library, only Req, Cond Perm is used for ADaM and SDTM Req, Exp and Perm. Are these values also acceptable for Core?</issue_description>

<agent_instructions>I need to update the information in the Readme to be more aligned with ADaM IG screenshot provided in the issue</agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits November 24, 2025 01:03
Co-authored-by: bms63 <10111024+bms63@users.noreply.github.com>
Co-authored-by: bms63 <10111024+bms63@users.noreply.github.com>
Copilot AI changed the title [WIP] Update Readme to clarify core values Align core attribute documentation with ADaM IG 1.3 and SDTM standards Nov 24, 2025
Copilot AI requested a review from bms63 November 24, 2025 01:09
@bms63
bms63 requested review from LiamHobby and cpiraux December 1, 2025 02:22
@bms63

bms63 commented Dec 1, 2025

Copy link
Copy Markdown
Collaborator

I asked copilot to do this - trying to figure out how to prompt things better!! seems like it got all the relevant points just from the issue!!

@bms63
bms63 marked this pull request as ready for review December 1, 2025 02:23
@codecov

codecov Bot commented Dec 1, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.44%. Comparing base (197b67f) to head (ec304aa).
⚠️ Report is 6 commits behind head on 80-documentation-core-in-readme.

Additional details and impacted files
@@                       Coverage Diff                        @@
##           80-documentation-core-in-readme     #127   +/-   ##
================================================================
  Coverage                            85.44%   85.44%           
================================================================
  Files                                    8        8           
  Lines                                 1175     1175           
================================================================
  Hits                                  1004     1004           
  Misses                                 171      171           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cpiraux cpiraux left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for this update! I have one small comment; the rest looks good to me!

Comment thread README.Rmd
Comment thread README.Rmd Outdated
Comment thread README.Rmd Outdated
@bms63

bms63 commented Dec 5, 2025

Copy link
Copy Markdown
Collaborator

@LiamHobby and @cpiraux all good?

@LiamHobby LiamHobby left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good. Thanks Ben!

@bms63 bms63 changed the title Align core attribute documentation with ADaM IG 1.3 and SDTM standards Closes #80 Align core attribute documentation with ADaM IG 1.3 and SDTM standards Dec 9, 2025
@bms63 bms63 linked an issue Dec 9, 2025 that may be closed by this pull request
@bms63
bms63 merged commit 3fc4c21 into 80-documentation-core-in-readme Dec 9, 2025
17 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: core in Readme

4 participants