[SOP Document] Multimodal Data Linkage

chorus-ai / Chorus_SOP

ChoRUS centralized SOP documentation site

https://chorus-ai.github.io/Chorus_SOP/

Apache License 2.0

1 stars 1 forks source link

[SOP Document] Multimodal Data Linkage #28

Open jshoughtaling opened 1 month ago

jshoughtaling commented 1 month ago

Work to be done for next draft of Linking SOP - TO DO PRIOR TO 16 May

[x] Create diagram of process - @jshoughtaling
[x] Define columns for IDs are necessary for registry - @wa6gz
[x] Language referring to details that will be provided in the Upload or the File format SOP - @jshoughtaling & @wa6gz E.g. "Sites will provide a mapping table between people and encounters and how that happens will be specified in the file format SOP {LINK TO IN PROCESS FILE FORMAT SOP}
[x] Description of registry - @jshoughtaling
[x] Scope - Andrew
[x] Audience - @wa6gz
[x] Purpose - Andrew
[x] How time format will be handled - @del42
[x] Folder structure - @wa6gz

Here's a link to the working branch with running additions: https://github.com/chorus-ai/Chorus_SOP/tree/review-multimodal-linkage

del42 commented 1 month ago

@jshoughtaling where is the doc draft? is it google doc?

jshoughtaling commented 1 month ago

@del42 - It's in the /sop-website/docs/Multimodal-Linkage directory on the branch linked above:

https://github.com/chorus-ai/Chorus_SOP/tree/review-multimodal-linkage/sop-website/docs/Multimodal-Linkage

There you'll find the PNG diagram, and the more detailed SOP document that accompanies it.

del42 commented 1 month ago

@jshoughtaling I see it. But how to add the draft? Just give it to you? Or Should I just modify the .mdx file?

jshoughtaling commented 1 month ago

@del42 - I created some guidelines in the main README. Feel free to suggest any additions there if they're still not clear.

Briefly:

Clone the Chorus_SOP repo locally and switch to the review-multimodal-linkage branch
Open the mdx SOP document in your editor of choice, ideally one that renders Markdown
Once you've made any edits or additions, commit those to the branch
Anything you're not sure about or would prefer to discuss, feel free to either comment here or open a discussion in this repo

wa6gz commented 1 month ago

Added a short audience message and spelled out some of the links to other SOPs past and present for file formatting, though more could probably be done here.