Skip to content

onconova.research.schemas.dataset

DataResource module-attribute

DatasetFiltersBase module-attribute

partial_schemas module-attribute

Dataset

Bases: DatasetCreate, MetadataMixin

cohortsIds class-attribute instance-attribute

lastExport class-attribute instance-attribute

totalExports class-attribute instance-attribute

DatasetCreate

Bases: BaseSchema

__orm_model__ class-attribute instance-attribute

externalSource class-attribute instance-attribute

externalSourceId class-attribute instance-attribute

name class-attribute instance-attribute

projectId class-attribute instance-attribute

rules class-attribute instance-attribute

summary class-attribute instance-attribute

DatasetFilters

Bases: DatasetFiltersBase

createdBy class-attribute instance-attribute

filter_createdBy(value)

Apply a filter for the creator's username.

Source code in onconova/research/schemas/dataset.py
def filter_createdBy(self, value: str) -> Q:
    """
    Apply a filter for the creator's username.
    """
    return Q(created_by=self.createdBy) if value is not None else Q()

DatasetRule

Bases: Schema

Schema representing a rule applied to a dataset resource.

Attributes:

Name Type Description
resource DataResource

The oncology resource this rule references.

field str

Dot-separated path of the field within the resource (e.g. 'medications.drug').

transform Nullable[str | Tuple[str, Any]]

Nullable transform expression or mapping applied to the field's value.

field class-attribute instance-attribute

resource class-attribute instance-attribute

transform class-attribute instance-attribute

ExportedPatientCaseDataset

Bases: ExportMetadata

dataset class-attribute instance-attribute

PatientCaseDataset

Bases: partial_schemas['PatientCase']

PatientCaseDataset schema representing a comprehensive dataset for a patient case in oncological research.

Attributes:

Name Type Description
pseudoidentifier str

Unique pseudoidentifier for the patient case.

neoplasticEntities Optional[List[NeoplasticEntity]]

List of neoplastic entities associated with the case.

tnmStagings Optional[List[TNMStaging]]

List of TNM staging resources.

figoStagings Optional[List[TNMStaging]]

List of FIGO staging resources.

binetStagings Optional[List[BinetStaging]]

List of Binet staging resources.

raiStagings Optional[List[RaiStaging]]

List of Rai staging resources.

breslowStagings Optional[List[BreslowDepth]]

List of Breslow depth resources.

clarkStagings Optional[List[ClarkStaging]]

List of Clark staging resources.

issStagings Optional[List[ISSStaging]]

List of ISS staging resources.

rissStagings Optional[List[RISSStaging]]

List of RISS staging resources.

inssStagings Optional[List[INSSStage]]

List of INSS staging resources.

inrgssStagings Optional[List[INRGSSStage]]

List of INRGSS staging resources.

gleasonStagings Optional[List[GleasonGrade]]

List of Gleason grade resources.

rhabdomyosarcomaGroups Optional[List[RhabdomyosarcomaClinicalGroup]]

List of rhabdomyosarcoma clinical group resources.

wilmsStagings Optional[List[WilmsStage]]

List of Wilms staging resources.

lymphomaStagings Optional[List[LymphomaStaging]]

List of lymphoma staging resources.

tumorMarkers Optional[List[TumorMarker]]

List of tumor marker resources.

riskAssessments Optional[List[RiskAssessment]]

List of risk assessment resources.

therapyLines Optional[List[TherapyLine]]

List of therapy line resources.

systemicTherapies Optional[List[SystemicTherapy]]

List of systemic therapy resources.

surgeries Optional[List[Surgery]]

List of surgery resources.

radiotherapies Optional[List[Radiotherapy]]

List of radiotherapy resources.

adverseEvents Optional[List[AdverseEvent]]

List of adverse event resources.

treatmentResponses Optional[List[TreatmentResponse]]

List of treatment response resources.

performanceStatus Optional[List[PerformanceStatus]]

List of performance status resources.

comorbidities Optional[List[ComorbiditiesAssessment]]

List of comorbidities assessment resources.

genomicVariants Optional[List[GenomicVariant]]

List of genomic variant resources.

tumorMutationalBurdens Optional[List[TumorMutationalBurden]]

List of tumor mutational burden resources.

microsatelliteInstabilities Optional[List[MicrosatelliteInstability]]

List of microsatellite instability resources.

lossesOfHeterozygosity Optional[List[LossOfHeterozygosity]]

List of loss of heterozygosity resources.

homologousRecombinationDeficiencies Optional[List[HomologousRecombinationDeficiency]]

List of homologous recombination deficiency resources.

tumorNeoantigenBurdens Optional[List[TumorNeoantigenBurden]]

List of tumor neoantigen burden resources.

aneuploidScores Optional[List[AneuploidScore]]

List of aneuploid score resources.

vitals Optional[List[Vitals]]

List of vital sign resources.

lifestyles Optional[List[Lifestyle]]

List of lifestyle resources.

familyHistory Optional[List[FamilyHistory]]

List of family history resources.

unspecifiedTumorBoards Optional[List[UnspecifiedTumorBoard]]

List of unspecified tumor board resources.

molecularTumorBoards Optional[List[UnspecifiedTumorBoard]]

List of molecular tumor board resources.

Note

All attributes are nullable and may contain lists of corresponding schema resources.

adverseEvents class-attribute instance-attribute

aneuploidScores class-attribute instance-attribute

binetStagings class-attribute instance-attribute

breslowStagings class-attribute instance-attribute

clarkStagings class-attribute instance-attribute

comorbidities class-attribute instance-attribute

familyHistory class-attribute instance-attribute

figoStagings class-attribute instance-attribute

genomicVariants class-attribute instance-attribute

gleasonStagings class-attribute instance-attribute

homologousRecombinationDeficiencies class-attribute instance-attribute

id class-attribute instance-attribute

inrgssStagings class-attribute instance-attribute

inssStagings class-attribute instance-attribute

issStagings class-attribute instance-attribute

lifestyles class-attribute instance-attribute

lossesOfHeterozygosity class-attribute instance-attribute

lymphomaStagings class-attribute instance-attribute

microsatelliteInstabilities class-attribute instance-attribute

molecularTumorBoards class-attribute instance-attribute

neoplasticEntities class-attribute instance-attribute

performanceStatus class-attribute instance-attribute

pseudoidentifier class-attribute instance-attribute

radiotherapies class-attribute instance-attribute

raiStagings class-attribute instance-attribute

rhabdomyosarcomaGroups class-attribute instance-attribute

riskAssessments class-attribute instance-attribute

rissStagings class-attribute instance-attribute

surgeries class-attribute instance-attribute

systemicTherapies class-attribute instance-attribute

therapyLines class-attribute instance-attribute

tnmStagings class-attribute instance-attribute

treatmentResponses class-attribute instance-attribute

tumorMarkers class-attribute instance-attribute

tumorMutationalBurdens class-attribute instance-attribute

tumorNeoantigenBurdens class-attribute instance-attribute

unspecifiedTumorBoards class-attribute instance-attribute

vitals class-attribute instance-attribute

wilmsStagings class-attribute instance-attribute

runner