Demo app task overview

[hjwilli]

This is a general ticket to keep track of the tasks necessary for the complete demo project goals. Subtickets can be created as necessary.

Demonstration goals/tasks with commentary:

• Define an example research question #13
• Create some CSV data sources #14
• Regenerate synthea db data #17
• Document how to set up a new Carnival application - create a new micronaut template project and/or update the demo docs with instructions on using the carnival plugin + micronaut directly
• (IN PROGRESS) Defining a Carnival graph model - We want @th5 and @louislee-ucla to work on this, but first we need more complete documentation.
  • Update Graph Model documentation page carnival#69 - @augustearth should update this with list of major features that need to be added
  • Create graph model for the demo #12
  • Update demo documentation for modeling - should focus more on the "why" then the "how". "how" should be addressed in the main carnival user and api docs.
• Combining data from different sources in a Carnival property graph - Depends on Carnival model to complete.
  • CSV vines - depends on creation of CSV files
  • EHR db vines - See Example vine methods #7, Db access example #8 for current work re DB vines.
• Executing graph operations to draw conclusions about the data - depends on main carnival documentation and research question
• Examining the providence of data in the graph - documentation, w. pictures of the graph?
• Examining the property graph directly - documentation, w. pictures of the graph?
• Presenting an API that allows users to do some basic graph exploration and analysis - as a first idea, just returning the results of the graph operation that produces the case and control cohorts
• (optional) a very simple webapp that hits the api endpoint and displays results and/or returns a report
• Rename the carnival-micronaut project #15

[louislee-ucla]

I pushed the API documentation to the demo branch. I directed the detailed descriptions to the walkthrough document to minimize redundancy.