mountetna / monoetna

mono-repository version of etna projects
GNU General Public License v2.0
1 stars 0 forks source link

Vulcan Workflow for Visualization of sc_seq_dataset #1237

Closed dtm2451 closed 1 year ago

dtm2451 commented 1 year ago

Primarily:

Remaining ToDos:

Additional changes to the larger UI System encoded here:

dtm2451 commented 1 year ago

Similar to the universal linker PR that's also in review now, testing this branch requires some particular development environment system setup:

  1. Connect your dev-vulcan to speak to the 'example' project in production-magma -- that's where I created the sc_seq_dataset model and seeded it with Seurat's mini test dataset. (Similar to the universal linker PR, using dev<->dev client/API interactions would require extra hacking. But for vulcan testing, Cole built a dev-vulcan<-production-magma pathway which has dual bonuses of getting around "strict = False" connection issues andddd also allows us to test vulcan with real data directly. We'll set that up here!)
    • Set up your vulcan config.yml to have it connect with production magma by:
      • giving a production token in line 11
      • the ucsf edu magma url in line 13.
      • also give :r: archimedes-r:latest in line 34 in order to be able to use the development archimedes-r interpreter.
    • Create a project via dev janus with "example" as its short name.
    • Give your dev user access to that project. Viewer perms should be enough here.
  2. Run the workflow!
    • (I'll try to give minimal required details here because your initial experience notes on the Vulcan UX would be pretty valuable on their own, Amadeo!)
    • Click into the example project from the dev-vulcan homepage
    • Click the scViz workflow's card and then the Create Figure button.
    • *Give the example dataset's record id to the single primary input -- EXAMPLE-SCD1 -- then Commit your choice and hit Run.
    • The next ui steps and everything that follows are where the real meat of this PR comes in... Play around with the visualization options and see if you can break anything!

*Re-design of the primary input entry point for the workflow is something I plan to focus on during alpha testing of the workflow. The current basic string entry method should be sufficient for the small group of alpha testers we'll have, and I have a few specific ideas already, so I'd like to consider that particular UX piece to be out-of-scope for this PR and not bog down any discussion there? (We'll probably switch to starting the workflow with an automatically run magma query followed by population of a purpose-built UI for selecting among all the projects' available sc_seq_datasets in a more descriptive way!)