Skip to content

add dataset submission metadata guide to README#291

Merged
SFJohnson24 merged 8 commits intomainfrom
dataset-submission-metadata-guide
Mar 5, 2026
Merged

add dataset submission metadata guide to README#291
SFJohnson24 merged 8 commits intomainfrom
dataset-submission-metadata-guide

Conversation

@alexfurmenkov
Copy link
Collaborator

No description provided.

docs/README.md Outdated

## Dataset submission metadata guide

For rules that work with dataset submission metadata (for example, rules of type Dataset Metadata Check, Dataset Metadata Check against Define XML), the user can reference dataset metadata attributes (for example: `name`, `unsplit_name`, `is_supp`, `domain`, `rdomain`, `is_ap`, `ap_suffix`) and apply operations over them (for example: `dataset_is_custom`, `related_domain`, `related_domain_is_custom`). The practical result of using these attributes and operations for different dataset names is illustrated in the table below.
Copy link
Collaborator

Choose a reason for hiding this comment

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

the metadata checks do not expose all of the properties you mentioned in this. is_supp, unsplit_name, rdomain, are not exposed to end-users (but could be here if we wanted). https://github.com/cdisc-org/cdisc-rules-engine/blob/07357c45cf3b3dcff58d61c705fbb131db33d945/cdisc_rules_engine/services/data_services/base_data_service.py#L211

Copy link
Collaborator

@SFJohnson24 SFJohnson24 left a comment

Choose a reason for hiding this comment

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

see comment-- please edit description to say 'can reference some of these attributes and then point to ones that are exposed in the rules). I would also mention this chart is how engine maps metadata throughout it's code logic

@OGarcia11 OGarcia11 linked an issue Mar 2, 2026 that may be closed by this pull request
Copy link
Collaborator

@SFJohnson24 SFJohnson24 left a comment

Choose a reason for hiding this comment

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

@alexfurmenkov @gerrycampion as discussed in scrum backlog refinement it would be good to have a column under the header that discusses where each column comes from -- i.e. domain is first value of DOMAIN column from source data

@SFJohnson24 SFJohnson24 self-requested a review March 5, 2026 14:58
@SFJohnson24 SFJohnson24 merged commit d3e7d9b into main Mar 5, 2026
9 checks passed
@SFJohnson24 SFJohnson24 deleted the dataset-submission-metadata-guide branch March 5, 2026 14:58
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.

Update Documents

3 participants