Create external facing data model docs

ncihtan / data-models

Schema.org Data Models for HTAN

MIT License

14 stars 6 forks source link

Create external facing data model docs #354

Closed aclayton555 closed 1 month ago

aclayton555 commented 4 months ago

Create docs that are external facing and update with the latest release of the data model. This has come up in a couple different conversation about providing information to contributors about the data model and standards in use for this community.

Currently, HTAN's data standards docs are pretty limited, and not very informative: HTAN: https://humantumoratlas.org/standards

Some examples in other communities:

NF-OSI: https://nf-osi.github.io/nf-metadata-dictionary/

VEOIBD: https://veoibd.github.io/data_models/

Gray: https://docs.graybrcaatlas.org/

MC2 (beta): https://mc2-center.github.io/data-models/ (generated in https://github.com/mc2-center/data-models/issues/49)

Good to talk to Anh Nguyet and Verena for ideas around implementation.

aclayton555 commented 4 months ago

Elvira will chat with Aditi about this and will re-assign. Goal for this sprint should be to have beta outline of docs. Next sprint, look to customize and expand

aclayton555 commented 4 months ago

Latest version of MC2 docs (just merged today) are a good example: https://mc2-center.github.io/data-models/

jen-dfci commented 4 months ago

Adding a copy of a potential data dictionary for data standards. As a part of the general HTAN documentation discussions, Kristen Anton explained that centers would like a downloadable form which could be used to map fields from their databases to HTAN fields. Although much of the information is contained in the manifests on the DCA, there are two issues: 1) Data preparers may not be the ones with DCA access 2) some of the information needed (e.g. valid values, required, required if....as well as field definitions) require interacting with the form. The attached data dictionary is a first draft -- waiting for feedback from Kristen. HTAN_Exposure_Data_Dictionary.xlsx

aclayton555 commented 3 months ago

Continue this into next sprint. Bring in Aditi.

aditigopalan commented 3 months ago

Please see #373

aclayton555 commented 2 months ago

Continue this work into next sprint; point to latest version of data model. As needed, set up time with Aditi and Jen to outline the docs landscape.

aclayton555 commented 1 month ago

Going into next sprint:

Jen's docs should focus on contextual components of RFC/data model
These docs should then supplement those docs and make available a viewable version of the data model.
Done: link to these docs from the data standards page on the HTAN Data Portal?

Action: bring this to our next Ops meeting to discuss with Onur and Ino. Want this to be updated through data model releases

aclayton555 commented 3 weeks ago

@aditigopalan can you provide the link to the HTAN docs? Also, was there a decision about whether to link these from the portal or the missing manual?