biocypher._create.BioCypherNode
- class biocypher._create.BioCypherNode(node_id: str, node_label: str, preferred_id: str = 'id', properties: dict = <factory>)
Handoff class to represent biomedical entities as Neo4j nodes.
Has id, label, property dict; id and label (in the Neo4j sense of a label, ie, the entity descriptor after the colon, such as “:Protein”) are non-optional and called node_id and node_label to avoid confusion with “label” properties. Node labels are written in PascalCase and as nouns, as per Neo4j consensus.
- Parameters:
node_id (string) – consensus “best” id for biological entity
node_label (string) – primary type of entity, capitalised
**properties (kwargs) – collection of all other properties to be passed to neo4j for the respective node (dict)
- __init__(node_id: str, node_label: str, preferred_id: str = 'id', properties: dict = <factory>) None
Methods
__init__(node_id, node_label[, ...])get_dict()Return dict of id, labels, and properties.
get_id()Returns primary node identifier.
get_label()Returns primary node label.
get_preferred_id()Returns preferred id.
get_properties()Returns all other node properties apart from primary id and label as key-value pairs.
get_type()Returns primary node label.
Attributes
preferred_idnode_idnode_labelproperties