graphkb.types¶
Type annotations used for static type checking in this module
Record¶
Record: TypedDict = TypedDict('Record', {'@rid': str, '@class': str})
Attributes
- @rid (
str
) - @class (
str
)
EmbeddedRecord¶
EmbeddedRecord: TypedDict = TypedDict('EmbeddedRecord', {'@class': str})
Attributes
- @class (
str
)
RecordLink¶
RecordLink = Union[str, Record]
OntologyLink¶
OntologyLink = Union[str, Ontology]
Position¶
Position = Union[BasicPosition, CytobandPosition]
CategoryBaseTermMapping¶
CategoryBaseTermMapping = List[Tuple[str, List[str]]]
class Ontology¶
inherits Record
Attributes
- sourceId (
str
) - name (
str
) - source (RecordLink)
- displayName (
str
)
class BasicPosition¶
inherits EmbeddedRecord
Attributes
- pos (
int
)
class CytobandPosition¶
inherits EmbeddedRecord
Attributes
- arm (
str
) - majorBand (
str
) - minorBand (
str
)
class Variant¶
inherits Record
Attributes
- reference1 (OntologyLink)
- reference2 (Optional[OntologyLink])
- type (OntologyLink)
- zygosity (
str
) - germline (
bool
) - displayName (
str
)
class PositionalVariant¶
inherits Variant
Attributes
- break1Start (Union[Position, CytobandPosition])
- break1End (Optional[Union[Position, CytobandPosition]])
- break2Start (Optional[Union[Position, CytobandPosition]])
- break2End (Optional[Union[Position, CytobandPosition]])
- refSeq (
Optional[str]
) - untemplatedSeq (
Optional[str]
) - untemplatedSeqSize (
Optional[int]
)
class ParsedVariant¶
inherits TypedDict
Attributes
- reference1 (
str
) - reference2 (
Optional[str]
) - type (
str
) - zygosity (
str
) - germline (
bool
) - break1Start (Union[Position, CytobandPosition])
- break1End (Optional[Union[Position, CytobandPosition]])
- break2Start (Optional[Union[Position, CytobandPosition]])
- break2End (Optional[Union[Position, CytobandPosition]])
- refSeq (
Optional[str]
) - untemplatedSeq (
Optional[str]
) - untemplatedSeqSize (
Optional[int]
)
class Statement¶
inherits Record
Attributes
- relevance (OntologyLink)
- subject (OntologyLink)
- conditions (List[OntologyLink])
- evidence (List[OntologyLink])
- evidenceLevel (List[OntologyLink])
- source (RecordLink)
- sourceId (
str
)