OpenCGA
OverviewInstallationUsing OpenCGA
v2.2
v2.2
  • 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
        • Files
      • Public Demo
    • Managing Data
      • Working with Projects and Studies
      • Loading of VCF files
      • Create Projects and Studies
      • Load VCF Files to a Study
      • Working with Files
      • Sharing and Permissions
        • Users and Groups
        • Study ACLs
      • Population of metadata
        • Data Versioning
        • Adding Custom Metadata
    • 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
  • Cohort
  • CohortInternal
  • Status
  • InternalStatus

Was this helpful?

  1. Data Models

Cohort

Overview

Cohort data model hosts information about any cohort.

Summary

Field
Create
Update
Unique
Required

id

uuid

type

creationDate

modificationDate

description

samples

numSamples

release

status

internal

attributes

Data Model

Cohort

Field
Description

id String

Object ID is a mandatory parameter when creating a new one, this ID cannot be changed at the moment.

uuid String

Unique 32-character identifier assigned automatically by OpenCGA.

type CohortType

Cohort type that can have the values CASE_CONTROL, CASE_SET, CONTROL_SET, PAIRED, PAIRED_TUMOR, AGGREGATE, TIME_SERIES, FAMILY, TRIO and COLLECTION.

creationDate String

Autogenerated date following the format YYYYMMDDhhmmss containing the date when the entry was first registered.

modificationDate String since: 1.0

Autogenerated date following the format YYYYMMDDhhmmss containing the date when the entry was last modified.

description String

Users may provide a description for the entry.

List of cohort samples.

numSamples int

Number of samples.

release int

An integer describing the current data release.

Object to set a custom status.

Internal field for manage the object.

attributes Map<String,Object>

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

CohortInternal

Field
Description

Status of the internal object.

registrationDate String

Registration date of the internal object.

lastModified String

Date of the last modification of the internal object.

Status

InternalStatus

PreviousFamilyNextJob

Last updated 2 years ago

Was this helpful?

You can find the Java code .

samples List<>

status

internal

You can find the Java code .

status

You can find the Java code .

You can find the Java code .

here
here
here
here
Sample
Status
CohortInternal
InternalStatus