Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 2.77 KB

project-name-standardization.md

File metadata and controls

36 lines (22 loc) · 2.77 KB
Raw
description
All begins with the meta_study.txt file

Project Name Standardization

Project Details

The general information of a cBioPortal project are described in a mandatory file, the meta_study.txt file. Within this file is where the project's name, project description, what reference genome build was used, the type of cancer the project is based on, etc. For all the available field options in the meta_study.txt file, please refer to the official cBioPortal's documentation.

Common meta_study fields used

cancer_study_identifier: <- usually the projects acronym
name: <- the naming structure goes here
description: <- description of what the project is about
type_of_cancer: <- The cancer type abbreviation, e.g., "brca". Please use the OncoTree Code
reference_genome: <- hg19 OR hg38
add_global_case_list: true

Name field

For a better user experience, we ask that each project import to follow a naming structure when filling out the details in the meta_study.txt file. By following this naming structure, the user can quickly grasp what a project is about and find what they are looking for.

The naming structure of the project Name is “ACRONYM: Top-level-OncoTree - Concept (PI, Centre)”

  1. ACRONYM <- if your study has an acronym for it
  2. Top-level-OncoTree <- the Cancer Type Detailed Name
  3. Concept <- Xenograft? Cell line? Clinical Trial? Landscape of cohorts? etc
  4. PI <- Main Principal Investigator of the project
  5. Centre <- which centre generated this data