Skip to content

Files

Latest commit

 

History

History
33 lines (25 loc) · 2.69 KB

README.md

File metadata and controls

33 lines (25 loc) · 2.69 KB

cBioPortal

The cBioPortal for Cancer Genomics provides visualization, analysis, and download of large-scale cancer genomics data sets. For a short intro on cBioPortal, see these introductory slides.

If you would like to know how to setup a private instance of the portal and/or get set up for developing, see the documentation. For details on contributing code changes via pull requests, see our Contributing document.

If you are interested in coordinating the development of new features, please contact cbioportal@cbioportal.org or reach out on https://slack.cbioportal.org.

📘 Documentation

See https://docs.cbioportal.org

  • The cBioPortal News page shows user focused release information (e.g. new data and new features)
  • The release notes on GitHub provide detailed information for each release for deployers/maintainers of cBioPortal
  • Docker Images are available for each tag and branch from Docker Hub

🐛 Bug Reports and Feature Requests

Please email us at cbioportal@googlegroups.com or file a ticket in the cbioportal/cbioportal isssue tracker.

📁 Repositories

Read the Architecture docs to see how these relate:

  • cbioportal: Backend
    • Read-only REST API written in Java Spring, which connects to MySQL database
    • Importer in Java Spring for loading data into MySQL database
    • Validator in Python for checking data file consistency with spec
  • cbioportal-frontend: Frontend in TypeScript/React
  • session-service: User Session Service in Java Spring
  • cbioportal-docker-compose: Recommended way to install cBioPortal and all its components using Docker
  • codebook: Analysis recipes for Python and R that leverage the cBioPortal REST API
  • datahub: Contains all public data files for published studies
  • datahub-study-curation-tools: Scripts to help curate studies for import into cBioPortal

📚 Cite

See How to Cite section of docs.