cbioportal icon indicating copy to clipboard operation
cbioportal copied to clipboard

user-friendly Generic Assay APIs

Open dippindots opened this issue 2 years ago • 1 comments

The current generic assay APIs are not very user friendly because the only use case is cBioPortal is pulling data from them, it's not easy to get started if users just want to explore data through those endpoints:

We should try to think about some improvement to make a user who don't have any knowledge about it can explore data. Here are some improvements we can make:

  • Add a new section API User Guide and create a documentation that give a step by step data exploration approach for Generic Assay data under section 6 in the cBioPortal documentation

  • Try to add a higher level description for the whole group of Generic Assay endpoints Screen Shot 2022-04-05 at 1 41 56 AM

  • Improve descriptions and examples for all existing APIs (We should add an simple example and explain what is the entity we are using and what can we get from this API)

  • (Need further discussion) We might need more endpoints or modify some existing parameters to smoothen the data exploration process

dippindots avatar Apr 05 '22 05:04 dippindots

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Jul 10 '22 04:07 stale[bot]