AllenInstitute / ACE

R Shiny app for comparison of annotations (e.g., cell type assignments)
Other
1 stars 1 forks source link

Improved documentation #2

Open jeremymiller opened 6 months ago

jeremymiller commented 6 months ago

I already have a user-guide in the app. I'd like to do the following.

  1. Update the install instructions: matching R shiny version (shiny_1.7.5.1) and also opening the .Rproj file directly?
  2. Keep it up to date!
  3. Link to it from the main readme page.
  4. (optional) create an interactive readme to the tool (or a video tutorial)
  5. Text description of what is being shown in each of the plots either via tool-tips or some other mechanism.
jeremymiller commented 2 weeks ago

One more thought. If we can't upload files, then an alternative (and possible something useful anyway) would be to add a section to the User Guide explaining how to create a gz.csv file in R and Excel, and then how to upload it to GitHub. This could potentially also be a short video tutorial. This might be part of a more general tutorial I need to make about how to use ACE to compare MapMyCells results from clustering results.