FredHutch/Oncoscape

Discussion on README.md

Closed this issue · 0 comments

canaantt commented

@LisaMc @grettygoose

README.md Improvement for GitHub launching
  • Mainly using the README.md on Develop branch
  • Do we need to update this link beta version?
  • A video to show how the General Users could utilize the application will be great.
Who are the users!
  • Identify the General Users as oncologists, physicians, wet-lab researchers, and scientists of other disciplines
Why Oncoscape is helpful?
  • How could Oncoscape help solve the problems that cannot easily be done in wet-lab within short period of time?
  • How could Oncoscape expand the vision of cancer researchers to think on the bigger landscape?
  • Oncoscape offer TCGA public dataset and potential private data but with much richer clinical data
    Oncoscape helps complete the flow of thought without requiring general users to download data to local machine, etc
  • The vision of collaboration with other institute and local computational strength [The unique strength Fred Hutch could offer]
What kind of help do we want?
  • Two folds: Front-end Developers including Visualization Expertise and Back-end Developers, who are more interested in new feature development... describing below.
  • Maybe add Gretchen’s diagram from CONTRIBUTING.md
  • Installation for both categories might be the same but the issues could be tagged separately.
Identify the three categories of users/contributors
  • General User:
    ** Could be oncologists, physicians, basic researchers, and scientists of other disciplines
    ** The targeted site is the webpage.
    ** General users do not need to install the application to local machine, but they should be able to leave feedback somehow.
    ** Tutorials, FAQ, News, Tools and About tabs, as well as a new link to crowdfunding.
  • Front-end developer:
    ** Includes Front-end contributors, Visualization contributors, and data scientists, etc
    ** create front-end focused Installation instruction and the development guideline.
    ** the area they could contribute, but not limited to, might be tabs
    Or in a specific tabs
    ** tag issues specific for Front-end focused contributors
  • Back-end developer:
    ** Includes Back-end developers, biostatisticians, computer scientists, bioinformaticians, etc
    ** new feature/new method development/collaboration
    ** the are they could contribute, but not limited to, might be developing R package
    Or directly create a new tab
    ** Other institute collaborators
    ** API development (link to other web applications)