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

expand vignettes #38

Closed
11 tasks
lwaldron opened this issue Apr 3, 2021 · 0 comments
Closed
11 tasks

expand vignettes #38

lwaldron opened this issue Apr 3, 2021 · 0 comments
Assignees

Comments

@lwaldron
Copy link
Member

lwaldron commented Apr 3, 2021

Good doc-a-thon items:

both vignettes:

  • some introduction with background / rationale for the package and what it provides, linking to sources of more information
  • citation & link to publication
  • link to workshops

User Start Guide:

  • why use this package? a little bit about cBioPortal and links / citations to more information about cBioPortal.
  • what does it provide? (summarize of RE and MAE, with links to more information. Assume analyst comes here first without ever having heard of RE and MAE, and maybe not even (R)SE.
  • How to know which datasets are available and working? Provide a link.
  • how to choose whether to use the datapacks or the API?
  • simple analysis examples
  • how to request a dataset that's not importing, or bugs

API Reference:

  • link to full API documentation
  • limitations on data access (e.g. gene panels or few genes)
LiNk-NY added a commit that referenced this issue Apr 19, 2021
LiNk-NY added a commit that referenced this issue Apr 29, 2021
update vignettes, refers to #38
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

3 participants