add dataset submission metadata guide to README#291
Conversation
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. |
There was a problem hiding this comment.
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
SFJohnson24
left a comment
There was a problem hiding this comment.
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
* Update ResultsTestStep.tsx * Update test_rule_editor.py
SFJohnson24
left a comment
There was a problem hiding this comment.
@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
…m/cdisc-org/conformance-rules-editor into dataset-submission-metadata-guide
No description provided.