OpenCGA
OverviewInstallationUsing OpenCGA
v2.1
v2.1
  • Home
  • Overview
    • Features
    • Architecture Diagram
    • Security
    • Metadata and Clinical Data
    • Data Models
      • Sample
      • Individual
    • Alignment and Coverage
    • Variant Query and Analysis
    • Clinical Data Analysis
    • Running Analysis
    • Scalability and Performance
    • Sizing OpenCGA
  • OpenCGA Architecture
    • Catalog
    • Alignment and Coverage
    • Variant Storage Engine
      • Variant Data Model
    • Clinical Analysis
    • Analysis Framework
  • Data Models
    • User
    • Project
    • Study
    • File
    • Sample
    • Individual
    • Family
    • Cohort
    • Job
    • Clinical Analysis
  • Case Studies
    • Genomics England Research
    • Microsoft Azure
  • User Manual
    • Installation
      • Kubernetes Cluster
        • Azure
        • Configuration
      • On-Premise HPC Cluster
        • Server Configuration
        • Getting OpenCGA
        • Choosing Variant Storage Engine
        • Configuration
      • Running Docker
    • Login
    • Using OpenCGA
      • REST Web Service API
      • IVA Web App
      • Client Libraries
        • pyopencga - Python Library
        • opencgaR - R library
        • Java
        • JavaScript
      • Command Line
        • Configuration
      • Public Demo
    • Managing Data
      • Sharing and Permissions
        • Users and Groups
        • Study ACLs
      • Create Projects and Studies
      • Load VCF Files to a Study
      • Working with Files
      • Population of Metadata
        • Adding Custom Metadata
        • Data Versioning
    • Alignment Engine
      • BAM Index
      • Alignment Read Query
      • Working with Coverage
      • Alignment Analysis
    • Variant Storage Engine
      • Variant Query
      • Variant Aggregation Stats
      • Variant Analysis
    • Clinical Genomics
      • Clinical Interpretation
      • Clinical Analysis
    • Using JupyterLab
    • Administrator
      • User Management
      • Templates / Manifest
  • About
    • Roadmap
    • Release Notes
    • Community
Powered by GitBook
On this page
  • Overview
  • Summary
  • Data Model
  • Project
  • Study
  • ProjectOrganism
  • SampleInternal
  • ProjectInternal
  • CohortInternal
  • StudyInternal

Was this helpful?

  1. Data Models

Project

Overview

Created by jacobo on 11/09/14.

Summary

Field

create

update

unique

required

id

name

fqn

description

organism

currentRelease

studies

attributes

uuid

creationDate

modificationDate

internal

Data Model

Project

Field

Description

id String

Project ID is a mandatory parameter when creating a new sample, this ID cannot be changed at the moment.Tags: required, immutable, unique

uuid String

Global unique ID at the whole OpenCGA installation. This is automatically created during the Project creation and cannot be changed.Tags: internal, unique, immutable

name String

fqn String

Full Qualified Name (user@projectId).

creationDate String

String representing when the sample was created, this is automatically set by OpenCGA.Tags: internal

modificationDate String

String representing when was the last time the sample was modified, this is automatically set by OpenCGA.Tags: internal

description String

An string to describe the properties of the sample.

currentRelease int

An object describing the internal information of the Project. This is managed by OpenCGA.Tags: internal

attributes Map<Object,String>

You can use this field to store any other information, keep in mind this is not indexed so you cannot search by attributes.

Study

Field

Description

id String

Study ID is a mandatory parameter when creating a new sample, this ID cannot be changed at the moment.Tags: required, immutable, unique

uuid String

Global unique ID at the whole OpenCGA installation. This is automatically created during the study creation and cannot be changed.Tags: internal, unique, immutable

name String

alias String

creationDate String

String representing when the sample was created, this is automatically set by OpenCGA.Tags: internal

modificationDate String

String representing when was the last time the sample was modified, this is automatically set by OpenCGA.Tags: internal

description String

An string to describe the properties of the sample.

size long

fqn String

A List with related groups.

A List with related files.

A List with related jobs.

A List with related individuals.

A List with related families.

A List with related samples.

A List with related cohorts.

panels List<org.opencb.opencga.core.models.panel.Panel>

A List with related panels.

A List with related clinicalAnalyses.

A List with related variableSets.

permissionRules Map<ListPermissionRule,Enums.Entity>

uri URI

release int

An object describing the status of the Sample.

An object describing the internal information of the Sample. This is managed by OpenCGA.Tags: internal

attributes Map<Object,String>

You can use this field to store any other information, keep in mind this is not indexed so you cannot search by attributes.

ProjectOrganism

Field

Description

scientificName String

commonName String

assembly String

SampleInternal

Field

Description

ProjectInternal

Field

Description

CohortInternal

Field

Description

StudyInternal

Field

Description

PreviousUserNextStudy

Last updated 3 years ago

Was this helpful?

You can find the Java code .

organism

studies List<>

internal

You can find the Java code .

notification

groups List<>

files List<>

jobs List<>

individuals List<>

families List<>

samples List<>

cohorts List<>

clinicalAnalyses List<>

variableSets List<>

status

internal

You can find the Java code .

You can find the Java code .

status

rga

You can find the Java code .

datastores

cellbase

status

You can find the Java code .

status

You can find the Java code .

status

configuration

here
here
here
here
here
here
here
ProjectOrganism
Study
ProjectInternal
StudyNotification
Group
File
Job
Individual
Family
Sample
Cohort
ClinicalAnalysis
VariableSet
CustomStatus
StudyInternal
Status
RgaIndex
Datastores
CellBaseConfiguration
Status
CohortStatus
Status
StudyConfiguration