Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved documentation #2

Open
jeremymiller opened this issue Apr 18, 2024 · 0 comments
Open

Improved documentation #2

jeremymiller opened this issue Apr 18, 2024 · 0 comments

Comments

@jeremymiller
Copy link
Collaborator

jeremymiller commented Apr 18, 2024

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) - Vilas or Tain may do this.
  5. Text description of what is being shown in each of the plots either via tool-tips or some other mechanism.
  6. Create an introduction section to the user guide and/or video about what ACE can be used for, and make an obvious button. What does ACE do and what doesn’t ACE do?
  7. Link back to MapMyCells? Create use cases, prerequisites for comparison (e.g., MapMyCells first), etc.
@jeremymiller jeremymiller changed the title User guide: improve and keep current Improved documentation Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant