PAGE-OM 1.0 FTF Avatar
  1. OMG Issue

PAGEOM_ — textual descriptions of the model objects are nearly completely absent

  • Key: PAGEOM_-24
  • Legacy Issue Number: 13806
  • Status: closed  
  • Source: Thematix Partners LLC ( Dr. Doug Tolbert)
  • Summary:

    All of the model objects seem to be listed, and there are some diagrams, but textual descriptions of the model objects are nearly completely absent. Those that exist are often (but not always) merely copied from the glossary. There is little (often no) semantic descriptions of model objects that would help the reader understand their intent. purpose, or best usage.

  • Reported: PAGE-OM 1.0b2 — Thu, 19 Mar 2009 04:00 GMT
  • Disposition: Resolved — PAGE-OM 1.0
  • Disposition Summary:

    Many classes got now better descriptions. But it is hard to list the
    changes here, in the resolution of the issue, because the changes were
    made by the UML tool and the documentation was re-generated. The FTF
    made the best effort to produce a change-bar document where all these
    changes will be visible.

    Regarding glossary, it is actually vice-versa: the glossary items were
    copied from the documentation of the model. Therefore, glossary is not
    (and never was) a normative part of the documentation. Its only reason
    is that it contains classes (and their synonyms) in alphabetic order,
    across all packages.


    • The class descriptions in the model have been updated. Regenerate
      documentation (chapter 7).
    • Generate glossary from the XMI and then replace the exiting
      glossary in full.
    • Add the following reference to the Annex C (References) - as the
      first reference in the table:

    Brookes et. al., The Phenotype and Genotype Experiment Object Model
    (PaGE-OM): A robust data structure for information related to DNA
    variation, Human Mutation (2009), vol 30, p. 1-16

  • Updated: Sat, 7 Mar 2015 03:28 GMT