clingen-data-model / clingen-interpretation

Allele (variant) interpretation model and API for ClinGen
3 stars 1 forks source link

Changes to sheets to remove types without additional structure #192

Closed bpow closed 6 years ago

bpow commented 6 years ago

Related to #185, we have had many discussions on conference calls about restructuring value-set validation.

As part of these discussions, I reluctantly agreed to remove the types that only served as tags of ValueSet membership (e.g., we did not define any additional structure for them, they can be represented just as IDs.

This "issue" is to keep track of changes to the sheets document that results, mostly to keep track and in hopes that nothing gets lost.

bpow commented 6 years ago

removed Gene.geneSymbol attribute, so Gene is now representable as just an IRI (with the expectation that label can be used for the gene symbol)

bpow commented 6 years ago

Removed the following "Types" from the type lists (since they do not define additional attributes/structure beyond an id and a label):

For now, things that used to be of these types have been bubbled up to DomainEntity (so we can keep track at least of labels...). Eventually we may change them to another type that doesn't get rendered in the documentation (per @cbizon's preference).

The types are still "there" in the sheets document (in case we change our minds...), but since I took out the values from their id column, they get ignored by the code that downloads and processes the sheets.

bpow commented 6 years ago

With removal of the DomainEntity subtypes listed above, @larrybabb's code to generate IDs using the prefix associated with the subtype broke.

I first made these IDs static (rather than generated from formulas), and am in the process of just using the IRI as the id.

bpow commented 6 years ago

made CanonicalAllele and ContextualAllele subtypes of DomainEntity, moved their relevant data into DomainEntity and _DomainEntityAttribute

bpow commented 6 years ago

Rolled back several 0..1 or 1..1 attributes from the respective _[Entity]Attribute tables into columns of the relevant [Entity] tables since I find this makes it easier to look at the data (and keeps the attribute tables much shorter)

In the process, some types that only had 0..1 and 1..1 attributes (no multi-valued attributes) now no longer need _[Entity]Attribute tables, so was able to remove sheets for:

bpow commented 6 years ago

Changes to Attributes sheet: all the DataType of things that used to refer to the deleted subtypes of DomainEntity are now "@id"

larrybabb commented 6 years ago

moved de-referenced sheets to an "archive" folder off of the root for now. Will merge content as we solidify organization of pages and verify that no more changes are needed for de-referenced types.

bpow commented 6 years ago

7bae547 reflects progress on this issue.

larrybabb commented 6 years ago

@bpow Is this closable?