Skip to content

monarch-py

Data models for the Monarch Initiative data access library

URI: https://w3id.org/monarch/monarch-py

Name: monarch-py

Classes

Class Description
Association
        DirectionalAssociation An association that gives it's direction relative to a specified entity
AssociationCountList Container class for a list of association counts
AssociationHighlighting Optional highlighting information for search results
AssociationTypeMapping A data class to hold the necessary information to produce association type co...
BestMatch
CaseEntity A case (patient) in the matrix
CasePhenotype A phenotype observed in at least one case
CasePhenotypeCellData Data for a single case-phenotype cell in the matrix
CasePhenotypeMatrixResponse Complete case-phenotype matrix for a disease
CompactAssociation
CrossSpeciesTermClique A grouping of species-specific terms (HP, MP, ZP) under a common cross-specie...
Entity Represents an Entity in the Monarch KG data model
        Node UI container class extending Entity with additional information
        SearchResult
EntityGridResponse Generic entity x entity grid response
ExpandedCurie A curie bundled along with its expanded url
FacetField
FacetValue
        AssociationCount
        HistoBin
GridBin A grouping bin for row entities
GridCellData Data for a cell in the grid
GridColumnEntity A column entity in the grid (case, disease, ortholog, etc
GridRowEntity A row entity in the grid (phenotype, GO term, anatomy, etc
HistoPheno
HistoPhenoBin A body system category for grouping phenotypes
Mapping A minimal class to hold a SSSOM mapping
NodeHierarchy
PairwiseSimilarity Abstract grouping for representing individual pairwise similarities
        TermPairwiseSimilarity A simple pairwise similarity between two atomic concepts/terms
        TermSetPairwiseSimilarity A simple pairwise similarity between two sets of concepts/terms
Qualifier A qualifier key-value pair for an association
Release A class to hold information about a release of the Monarch KG
Results
        AssociationResults
        AssociationTableResults
        CategoryGroupedAssociationResults
        CompactAssociationResults
        EntityResults
        MappingResults SSSOM Mappings returned as a results collection
        MultiEntityAssociationResults
        SearchResults
SemsimSearchResult
TermInfo
TextAnnotationResult

Slots

Slot Description
agent_type Describes the high-level category of agent who originally generated a statem...
aggregator_knowledge_source
ancestor_id the most recent common ancestor of the two compared entities
ancestor_information_content The IC of the object
ancestor_label the name or label of the ancestor concept
ancestor_source
associated_categories
association_counts
average_score
best_score
bin_id The identifier for the histopheno bin a phenotype belongs to
bins List of histopheno bins for grouping phenotypes
broad_synonym A broader synonym for the entity
cases List of case entities in the matrix
category
causal_gene A list of genes that are known to be causally associated with a disease
causes_disease A list of diseases that are known to be causally associated with a gene
cells Map of case-phenotype cell data keyed by case_id:phenotype_id
clique_associations All associations within this clique: vertical (subclass_of from children to r...
clique_entities Species-specific child terms (HP, MP, ZP, etc
columns List of column entities
context_category The biolink category of the context entity
context_id The identifier of the context entity (e
context_name The name of the context entity
cosine_similarity the dot product of two node embeddings divided by the product of their length...
count count of documents
count_direct Count of direct associations (no closure/descendants)
count_with_orthologs Count including associations from orthologous genes
counterpart_category The category of the counterpart entity in a given association, eg
cross_species_term_clique
deprecated A boolean flag indicating that an entity is no longer considered current or v...
description
dice_similarity
direction The directionality of the association relative to a given entity for an assoc...
disease_context_qualifier A context qualifier representing a disease or condition in which a relationsh...
disease_context_qualifier_category The category of the disease_context_qualifier entity
disease_context_qualifier_closure Field containing disease_context_qualifier id and the ids of all of it's ance...
disease_context_qualifier_closure_label Field containing disease_context_qualifier name and the names of all of it's ...
disease_context_qualifier_label The name of the disease_context_qualifier entity
disease_context_qualifier_namespace The namespace/prefix of the disease_context_qualifier entity
disease_id The identifier for a disease entity
disease_name The name of a disease entity
end end position of the annotation
evidence_count count of supporting documents, evidence codes, and sources supplying evidence
exact_synonym An exact synonym for the entity
external_links ExpandedCurie with id and url for xrefs
facet_fields Collection of facet field responses with the field values and counts
facet_queries Collection of facet query responses with the query string values and counts
facet_values Collection of FacetValue label/value instances belonging to a FacetField
FDA_adverse_event_level The level of FDA adverse event reporting for a drug-condition association
frequency_qualifier
frequency_qualifier_category The category of the frequency_qualifier entity
frequency_qualifier_label The name of the frequency_qualifier entity
frequency_qualifier_namespace The namespace/prefix of the frequency_qualifier entity
full_id The full identifier for an entity
full_name The long form name of an entity
graph_stats
grouping_key A concatenation of fields used to group associations with the same essential/...
has_biological_sex The biological sex of an individual entity
has_count count of out of has_total representing a frequency
has_descendant A list of entity identifiers that are known to be descendants of this entity
has_descendant_count A count of the number of entities that are known to be descendants of this en...
has_descendant_label A list of entity labels that are known to be descendants of this entity
has_evidence
has_evidence_links List of ExpandedCuries with id and url for evidence
has_percentage percentage, which may be calculated from has_count and has_total, as 100 * qu...
has_phenotype A list of phenotype identifiers that are known to be associated with this ent...
has_phenotype_closure A list of phenotype identifiers that are known to be associated with this ent...
has_phenotype_closure_label A list of phenotype labels that are known to be associated with this entity e...
has_phenotype_count A count of the number of phenotypes that are known to be associated with this...
has_phenotype_label A list of phenotype labels that are known to be associated with this entity
has_quotient quotient, which should be 1/100 of has_percentage
has_total total, devided by has_count, representing a frequency
highlighting Optional highlighting information for search results
id
in_taxon The biolink taxon that the entity is in the closure of
in_taxon_label The label of the biolink taxon that the entity is in the closure of
information_content The IC is the negative log of the probability of the concept
inheritance
intersection_count
iri
is_direct Whether the case is directly associated with the disease or via a descendant
items A collection of items, with the type to be overriden by slot_usage
jaccard_similarity The number of concepts in the intersection divided by the number in the union
kg
knowledge_level Describes the level of knowledge expressed in a statement, based on the reaso...
knowledge_source
label
limit number of items to return in a response
mapping_justification
mappings List of ExpandedCuries with id and url for mapped entities
match_source
match_source_label
match_subsumer
match_subsumer_label
match_target the entity matches
match_target_label
metadata
metric
name
namespace The namespace/prefix portion of this entity's identifier
narrow_synonym A narrower synonym for the entity
negated
neo4j
node_hierarchy
object
object_aspect_qualifier Composes with the core concept (+ qualifier) to describe new concepts of a mo...
object_best_matches
object_category The category of the object entity
object_closure Field containing object id and the ids of all of it's ancestors
object_closure_label Field containing object name and the names of all of it's ancestors
object_id
object_information_content The IC of the object
object_label The name of the object entity
object_namespace The namespace/prefix of the object entity
object_source the source for the second entity
object_specialization_qualifier A qualifier that composes with a core subject/object concept to define a more...
object_specialization_qualifier_category The category of the object_specialization_qualifier
object_specialization_qualifier_closure A closure of the object_specialization_qualifier, including the object_specia...
object_specialization_qualifier_closure_label A closure of the object_specialization_qualifier, including the object_specia...
object_specialization_qualifier_label A label for the object_specialization_qualifier
object_specialization_qualifier_namespace The namespace/prefix of the object_specialization_qualifier
object_taxon
object_taxon_label
object_termset
offset offset into the total number of items
onset_qualifier
onset_qualifier_category The category of the onset_qualifier entity
onset_qualifier_label The name of the onset_qualifier entity
onset_qualifier_namespace The namespace/prefix of the onset_qualifier entity
original_object
original_predicate used to hold the original relation/predicate that an external knowledge sourc...
original_subject
overlap_coefficient
pathway
phenodigm_score the geometric mean of the jaccard similarity and the information content
phenotype_count Number of phenotypes in a bin
phenotype_ids List of phenotype identifiers belonging to a bin
phenotypes List of phenotype entities in the matrix
predicate
predicate_id
present Whether the phenotype is present for a case
primary_knowledge_source
provided_by
provided_by_link A link to the docs for the knowledge source that provided the node/edge
publications
publications_links List of ExpandedCuries with id and url for publications
qc_report
qualifier
qualifier_category The category of the frequency_qualifier entity
qualifier_label The name of the frequency_qualifier entity
qualifier_namespace The namespace/prefix of the frequency_qualifier entity
qualifiers
qualifiers_category The category of the frequency_qualifier entity
qualifiers_closure Field containing frequency_qualifier id and the ids of all of it's ancestors
qualifiers_closure_label Field containing frequency_qualifier name and the names of all of it's ancest...
qualifiers_label The name of the frequency_qualifier entity
qualifiers_namespace The namespace/prefix of the frequency_qualifier entity
related_synonym A related synonym for the entity
root_term The species-independent grouping term (UPHENO/UBERON) that serves as the cros...
rows List of row entities
score
sex_qualifier
sex_qualifier_category The category of the sex_qualifier entity
sex_qualifier_label The name of the sex_qualifier entity
sex_qualifier_namespace The namespace/prefix of the sex_qualifier entity
similarity
solr
source_association_category The biolink category of the source association
source_association_evidence_count Number of evidence items supporting the source association
source_association_predicate The predicate of the source association
source_association_primary_knowledge_source Primary knowledge source for the source association
source_association_publications Publication CURIEs supporting the source association
source_disease_id The disease ID that a case is indirectly associated with (for descendant dise...
source_disease_label The label of the source disease for indirect case associations
source_id For indirect associations, the ID of the direct entity
source_label For indirect associations, the label of the direct entity
species_context_qualifier A context qualifier representing a species in which a relationship expressed ...
species_context_qualifier_category The category of the species_context_qualifier entity
species_context_qualifier_label The name of the species_context_qualifier entity
species_context_qualifier_namespace The namespace/prefix of the species_context_qualifier entity
sqlite
stage_qualifier
stage_qualifier_category The category of the stage_qualifier entity
stage_qualifier_label The name of the stage_qualifier entity
stage_qualifier_namespace The namespace/prefix of the stage_qualifier entity
start start position of the annotation
sub_classes
subject
subject_best_matches
subject_category The category of the subject entity
subject_closure Field containing subject id and the ids of all of it's ancestors
subject_closure_label Field containing subject name and the names of all of it's ancestors
subject_id
subject_information_content The IC of the subject
subject_label The name of the subject entity
subject_namespace The namespace/prefix of the subject entity
subject_source the source for the first entity
subject_specialization_qualifier A qualifier that composes with a core subject/object concept to define a more...
subject_specialization_qualifier_category The category of the subject_specialization_qualifier
subject_specialization_qualifier_closure A closure of the subject_specialization_qualifier, including the subject_spec...
subject_specialization_qualifier_closure_label A closure of the subject_specialization_qualifier, including the subject_spec...
subject_specialization_qualifier_label A label for the subject_specialization_qualifier
subject_specialization_qualifier_namespace The namespace/prefix of the subject_specialization_qualifier
subject_taxon
subject_taxon_label
subject_termset
subsets A list of subsets that the entity belongs to
subsumed_by_score
subsumes_score
super_classes
supporting_text The text in a publication that supports the assertion in the association
symbol
symmetric Whether the association type is symmetric, i
synonym
taxon The taxon ID of the entity
taxon_label The taxon label of the entity
text text without tokens
tokens A collection of entities or concepts
total total number of items matching a query
total_cases Total number of cases in the matrix
total_columns Total number of column entities in the grid
total_phenotypes Total number of phenotypes in the matrix
total_rows Total number of row entities in the grid
type The type of the entity (e
union_count
uri The URI of the entity
url
value The value of a qualifier
version
xref

Enumerations

Enumeration Description
AssociationDirectionEnum The directionality of an association as it relates to a specified entity, wit...

Types

Type Description
Boolean A binary (true or false) value
Curie a compact URI
Date a date (year, month and day) in an idealized calendar
DateOrDatetime Either a date or a datetime
Datetime The combination of a date and time
Decimal A real number with arbitrary precision that conforms to the xsd:decimal speci...
Double A real number that conforms to the xsd:double specification
Float A real number that conforms to the xsd:float specification
Integer An integer
ItemCount
Jsonpath A string encoding a JSON Path
Jsonpointer A string encoding a JSON Pointer
Ncname Prefix part of CURIE
NegativeLogValue
Nodeidentifier A URI, CURIE or BNODE that represents a node in a model
NonNegativeFloat
Objectidentifier A URI or CURIE that represents an object in the model
Sparqlpath A string encoding a SPARQL Property Path
String A character string
Time A time object represents a (local) time of day, independent of any particular...
Uri a complete URI
Uriorcurie a URI or a CURIE
ZeroToOne

Subsets

Subset Description