Helpful tips on how to prepare files for cBioPortal
Preparing your files for upload to cBioPortal requires careful formatting and planning. This guide provides an overview of the process and links to examples, validation tools, and helper scripts.
🧰 Before You Begin
- Create a folder to store your study files.
The folder name must match the study ID given by the cBioPortal team. This ID must also appear in your meta files undercancer_study_identifier
.
📝 Note: If you’d like to request a new or updated study ID, email the Data Governance team.
- Once your files are nearly ready, validate them:
- Approved studies: Upload to the
fh-dasl-cbio
bucket. You’ll receive a validation report by email. - Testing locally: Try running a local instance of cBioPortal and validate your study manually.
- Approved studies: Upload to the
📄 Required and Optional Study Files
To be accepted for upload, your study must contain some required files. Others are optional but recommended depending on your dataset.
📝 Note: Version 6 of cBioPortal requires at least one non-clinical file.
🛠️ Public Tools to Help Format Your Files
These tools can help convert, validate, or format your data for cBioPortal. Choose the one that fits your data type and workflow best.
For more details, explore the full formatting documentation and helper tools here:
🔗 Full File Format Guide by cBioPortal
🔧 Overview of what a completed data “package” would look like for upload into cBioportal.