Publish app's Input data specification

[aclark02-arcus]

Related to #20, it would be nice if there was a published specification created that defined what the "raw data" or "merged data" needs to look like in order to play nicely with the clinsight app.

[aclark02-arcus]

Initiated with #39

[aclark02-arcus]

Hi @LDSamson, is there a minimum amount of domains/ forms that need to be prepared (using get_raw_data() and merge_meta_with_data()) in order to launch the app? For example, what if I only prepare dm, cm, and mh, but I don't include any lab or VS forms? Would the app still function as expected (assuming I updated the metadata.xlsx file appropriately)?

[aclark02-arcus]

Hi @LDSamson, another question for you: when it comes to building the metadata.xlsx, how do I populate this tab (and other tabs like it)? Should I seek to supply the variable names that coincide with the item name because the app requires those vars? Or can I put whatever variables I want in here, as long as I give them a name?

[LDSamson]

Some tips for filling out the metadata:

• don't change column names
• the var and suffix fields can always be changed to the study-specific value of the variable
• most other variables you can change as desired; these will affect how the data will be displayed in the application. Exceptions are data points that are currently hard coded in the app; I marked them yellow in the metadata excel file below; these should probably left as they are at the moment. They can be missing in the actual data though.
• You can add any rows that you want in the study_forms and common_forms tabs. There you can also change the item_group
• several items in the General tab are currently unused. They can probably be removed. See again the Excel file for which ones are currently in use.
  metadata (1).xlsx

[LDSamson]

Hi @LDSamson, is there a minimum amount of domains/ forms that need to be prepared (using get_raw_data() and merge_meta_with_data()) in order to launch the app? For example, what if I only prepare dm, cm, and mh, but I don't include any lab or VS forms? Would the app still function as expected (assuming I updated the metadata.xlsx file appropriately)?

Forms are mostly optional and can be left out if needed. Exceptions are rows colored in yellow in the metadata.xlsx file in my previous message.

We should test how well it works if there are for example no study_forms at all; I think it will work if there is just an empty table in the study_forms tab, but we should check it.

[aclark02-arcus]

rows colored in yellow in the metadata.xlsx file in my previous message.

I completely forgot about that resource you shared. Many apologies!

[LDSamson]

No problem of course!