medmodels.medrecord.medrecord.MedRecord#

class MedRecord[source]#

Bases: object

A class to manage medical records with node and edge data structures.

Provides methods to create instances from different data formats, manage node and edge attributes, and perform operations like adding or removing nodes and edges.

__init__()[source]#: Initializes a MedRecord instance with an underlying PyMedRecord object.

Methods

`__init__`()	Initializes a MedRecord instance with an underlying PyMedRecord object.
`add_edges`(edges[, group])	Adds edges to the MedRecord instance from various data formats.
`add_edges_pandas`(edges[, group])	Adds edges to the MedRecord from one or more Pandas DataFrames.
`add_edges_polars`(edges[, group])	Adds edges to the MedRecord from one or more Polars DataFrames.
`add_edges_to_group`(group, edges)	Adds one or more edges to a specified group in the MedRecord.
`add_group`(group[, nodes, edges])	Adds a group to the MedRecord instance with an optional list of node indices.
`add_nodes`(nodes[, group])	Adds nodes to the MedRecord from different data formats.
`add_nodes_pandas`(nodes[, group])	Adds nodes to the MedRecord instance from one or more Pandas DataFrames.
`add_nodes_polars`(nodes[, group])	Adds nodes to the MedRecord instance from one or more Polars DataFrames.
`add_nodes_to_group`(group, nodes)	Adds one or more nodes to a specified group in the MedRecord.
`builder`()	Creates a MedRecordBuilder instance to build a MedRecord.
`clear`()	Clears all data from the MedRecord instance.
`clone`()	Clones the MedRecord instance.
`contains_edge`(edge)	Checks whether a specific edge exists in the MedRecord.
`contains_group`(group)	Checks whether a specific group exists in the MedRecord.
`contains_node`(node)	Checks whether a specific node exists in the MedRecord.
`edge_count`()	Returns the total number of edges currently managed by the MedRecord.
`edge_endpoints`(edge)	Retrieves the source and target nodes of the specified edge(s).
`edges_connecting`(source_node, target_node[, ...])	Retrieves the edges connecting the specified source and target nodes.
`edges_in_group`(group)	Retrieves the edge indices associated with the specified group(s).
`from_advanced_example_dataset`()	Creates a MedRecord instance from an advanced example dataset.
`from_pandas`(nodes[, edges])	Creates a MedRecord from Pandas DataFrames of nodes and optionally edges.
`from_polars`(nodes[, edges])	Creates a MedRecord from Polars DataFrames of nodes and optionally edges.
`from_ron`(path)	Creates a MedRecord instance from a RON file.
`from_simple_example_dataset`()	Creates a MedRecord instance from a simple example dataset.
`from_tuples`(nodes[, edges])	Creates a MedRecord instance from lists of node and edge tuples.
`group`(group)	Returns the node and edge indices associated with the specified group/s.
`group_count`()	Returns the total number of groups currently defined within the MedRecord.
`groups_of_edge`(edge)	Retrieves the groups associated with the specified edge(s) in the MedRecord.
`groups_of_node`(node)	Retrieves the groups associated with the specified node(s) in the MedRecord.
`incoming_edges`(node)	Lists the incoming edges of the specified node(s) in the MedRecord.
`neighbors`(node[, directed])	Retrieves the neighbors of the specified node(s) in the MedRecord.
`node_count`()	Returns the total number of nodes currently managed by the MedRecord.
`nodes_in_group`(group)	Retrieves the node indices associated with the specified group/s.
`outgoing_edges`(node)	Lists the outgoing edges of the specified node(s) in the MedRecord.
`overview_edges`([groups, decimal])	Gets a summary for all edges in groups and their attributes.
`overview_nodes`([groups, decimal])	Gets a summary for all nodes in groups and their attributes.
`remove_edges`(edges)	Removes edges from the MedRecord and returns their attributes.
`remove_edges_from_group`(group, edges)	Removes one or more edges from a specified group in the MedRecord.
`remove_groups`(groups)	Removes one or more groups from the MedRecord instance.
`remove_nodes`(nodes)	Removes nodes from the MedRecord and returns their attributes.
`remove_nodes_from_group`(group, nodes)	Removes one or more nodes from a specified group in the MedRecord.
`select_edges`(query)	Selects edges from the MedRecord based on the provided query.
`select_nodes`(query)	Selects nodes from the MedRecord based on the provided query.
`to_ron`(path)	Writes the MedRecord instance to a RON file.
`with_schema`(schema)	Creates a MedRecord instance with the specified schema.

Attributes

`edge`	Provides access to edge attributes within the MedRecord via an indexer.
`edges`	Lists the edge indices in the MedRecord instance.
`groups`	Lists the groups in the MedRecord instance.
`node`	Provides access to node attributes within the MedRecord via an indexer.
`nodes`	Lists the node indices in the MedRecord instance.
`schema`	Returns the schema of the MedRecord instance.

__repr__()[source]#

Returns an official string representation of the MedRecord instance.

Return type:: str

add_edges(edges, group=None)[source]#

Adds edges to the MedRecord instance from various data formats.

Accepts edge tuple, lists of tuples, DataFrame(s), or EdgeDataFrameInput(s) to add edges. Each tuple must have indices for source and target nodes and a dictionary of attributes. If a DataFrame or list of DataFrames is used, the add_edges_dataframe method is invoked. If PolarsEdgeDataFrameInput(s) are provided, each tuple must include a DataFrame and index columns for source and target nodes. If a group is specified, the edges are added to the group.

Parameters:

edges (EdgeInput) – Data representing edges in several formats.
group (Optional[Group]) – The name of the group to add the edges to. If not specified, the edges are added to the MedRecord without a group.

Return type:

List[int]

Returns:

List[EdgeIndex] – A list of edge indices that were added.

add_edges_pandas(edges, group=None)[source]#

Adds edges to the MedRecord from one or more Pandas DataFrames.

This method accepts either a single PandasEdgeDataFrameInput tuple or a list of such tuples, each including a DataFrame and index columns for the source and target nodes. If a group is specified, the edges are added to the group.

Parameters:

edges (Union[PandasEdgeDataFrameInput, List[PandasEdgeDataFrameInput]]) – A tuple or list of tuples, each including a DataFrame and index columns for source and target nodes.
group (Optional[Group]) – The name of the group to add the edges to. If not specified, the edges are added to the MedRecord without a group.

Return type:

List[int]

Returns:

List[EdgeIndex] – A list of the edge indices added.

add_edges_polars(edges, group=None)[source]#

Adds edges to the MedRecord from one or more Polars DataFrames.

This method accepts either a single PolarsEdgeDataFrameInput tuple or a list of such tuples, each including a DataFrame and index columns for the source and target nodes. If a group is specified, the edges are added to the group.

Parameters:

edges (Union[PolarsEdgeDataFrameInput, List[PolarsEdgeDataFrameInput]]) – A tuple or list of tuples, each including a DataFrame and index columns for source and target nodes.
group (Optional[Group]) – The name of the group to add the edges to. If not specified, the edges are added to the MedRecord without a group.

Return type:

List[int]

Returns:

List[EdgeIndex] – A list of the edge indices added.

add_edges_to_group(group, edges)[source]#

Adds one or more edges to a specified group in the MedRecord.

Parameters:

group (Group) – The name of the group to add edges to.
edges (Union[EdgeIndex, EdgeIndexInputList, EdgeQuery]) – One or more edge indices or an edge query to add to the group.

Return type:

None

Returns:

None

add_group(group, nodes=None, edges=None)[source]#

Adds a group to the MedRecord instance with an optional list of node indices.

If node indices are specified, they are added to the group. If no nodes are specified, the group is created without any nodes.

Parameters:

group (Group) – The name of the group to add.
nodes (Optional[Union[NodeIndex, NodeIndexInputList, NodeQuery]]) – One or more node indices or a node query to add to the group, optional.
edges (Optional[Union[EdgeIndex, EdgeIndexInputList, EdgeQuery]]) – One or more edge indices or an edge query to add to the group, optional.

Return type:

None

Returns:

None

add_nodes(nodes, group=None)[source]#

Adds nodes to the MedRecord from different data formats.

Accepts a node tuple (single node added), a list of tuples, DataFrame(s), or PolarsNodeDataFrameInput(s) to add nodes. If a DataFrame or list of DataFrames is used, the add_nodes_pandas method is called. If PolarsNodeDataFrameInput(s) are provided, each tuple must include a DataFrame and the index column. If a group is specified, the nodes are added to the group.

Parameters:

nodes (NodeInput) – Data representing nodes in various formats.
group (Optional[Group]) – The name of the group to add the nodes to. If not specified, the nodes are added to the MedRecord without a group.

Return type:

None

add_nodes_pandas(nodes, group=None)[source]#

Adds nodes to the MedRecord instance from one or more Pandas DataFrames.

This method accepts either a single tuple or a list of tuples, where each tuple consists of a Pandas DataFrame and an index column string. If a group is specified, the nodes are added to the group.

Parameters:

nodes (Union[PandasNodeDataFrameInput, List[PandasNodeDataFrameInput]]) – A tuple or list of tuples, each with a DataFrame and index column.
group (Optional[Group]) – The name of the group to add the nodes to. If not specified, the nodes are added to the MedRecord without a group.

Return type:

None

add_nodes_polars(nodes, group=None)[source]#

Adds nodes to the MedRecord instance from one or more Polars DataFrames.

This method accepts either a single tuple or a list of tuples, where each tuple consists of a Polars DataFrame and an index column string. If a group is specified, the nodes are added to the group.

Parameters:

nodes (Union[PolarsNodeDataFrameInput, List[PolarsNodeDataFrameInput]]) – A tuple or list of tuples, each with a DataFrame and index column.
group (Optional[Group]) – The name of the group to add the nodes to. If not specified, the nodes are added to the MedRecord without a group.

Return type:

None

add_nodes_to_group(group, nodes)[source]#

Adds one or more nodes to a specified group in the MedRecord.

Parameters:

group (Group) – The name of the group to add nodes to.
nodes (Union[NodeIndex, NodeIndexInputList, NodeQuery]) – One or more node indices or a node query to add to the group.

Return type:

None

Returns:

None

static builder()[source]#

Creates a MedRecordBuilder instance to build a MedRecord.

Return type:: MedRecordBuilder
Returns:: MedRecordBuilder – A new builder instance.

clear()[source]#

Clears all data from the MedRecord instance.

Removes all nodes, edges, and groups, effectively resetting the instance.

Return type:: None
Returns:: None

clone()[source]#

Clones the MedRecord instance.

Return type:: MedRecord
Returns:: MedRecord – A clone of the MedRecord instance.

contains_edge(edge)[source]#

Checks whether a specific edge exists in the MedRecord.

Parameters:: edge (EdgeIndex) – The index of the edge to check.
Return type:: bool
Returns:: bool – True if the edge exists, False otherwise.

contains_group(group)[source]#

Checks whether a specific group exists in the MedRecord.

Parameters:: group (Group) – The name of the group to check.
Return type:: bool
Returns:: bool – True if the group exists, False otherwise.

contains_node(node)[source]#

Checks whether a specific node exists in the MedRecord.

Parameters:: node (NodeIndex) – The index of the node to check.
Return type:: bool
Returns:: bool – True if the node exists, False otherwise.

property edge: EdgeIndexer#

Provides access to edge attributes within the MedRecord via an indexer.

Facilitates querying, accessing, manipulating, and setting edge attributes using various indexing methods. Supports conditions and ranges for more complex queries.

Returns:: EdgeIndexer – An object for manipulating and querying edge attributes.

edge_count()[source]#

Returns the total number of edges currently managed by the MedRecord.

Return type:: int
Returns:: int – The total number of edges.

edge_endpoints(edge)[source]#

Retrieves the source and target nodes of the specified edge(s).

If a single edge index is provided, returns a tuple of node indices (source, target). If multiple edges are specified, returns a dictionary mapping each edge index to its tuple of node indices.

Parameters:

edge (Union[EdgeIndex, EdgeIndexInputList, EdgeQuery]) – One or more edge indices or an edge query.

Return type:

Union[tuple[Union[str, int], Union[str, int]], Dict[int, tuple[Union[str, int], Union[str, int]]]]

Returns:

Union[tuple[NodeIndex, NodeIndex],: Dict[EdgeIndex, tuple[NodeIndex, NodeIndex]]]: Tuple of node indices or a dictionary mapping each edge to its node indices.

property edges: List[int]#

Lists the edge indices in the MedRecord instance.

Returns a list of all edge indices currently managed by the MedRecord instance.

Returns:: List[EdgeIndex] – A list of edge indices.

edges_connecting(source_node, target_node, directed=EdgesDirected.DIRECTED)[source]#

Retrieves the edges connecting the specified source and target nodes.

If a NodeOperation is provided for either the source or target nodes, it is first evaluated to obtain the corresponding node indices. The method then returns a list of edge indices that connect the specified source and target nodes.

Parameters:

source_node (Union[NodeIndex, NodeIndexInputList, NodeQuery]) – The index or indices of the source node(s), or a node query to select source nodes.
target_node (Union[NodeIndex, NodeIndexInputList, NodeQuery]) – The index or indices of the target node(s), or a node query to select target nodes.
directed (EdgesDirected, optional) – Whether to consider edges as directed. Defaults to EdgesDirected.DIRECTED.

Return type:

List[int]

Returns:

List[EdgeIndex] –

A list of edge indices connecting the specified source and: target nodes.

edges_in_group(group)[source]#

Retrieves the edge indices associated with the specified group(s).

If a single group is specified, returns a list of edge indices for that group. If multiple groups are specified, returns a dictionary mapping each group name to its list of edge indices.

Parameters:

group (GroupInputList) – One or more group names.

Return type:

Union[List[int], Dict[Union[str, int], List[int]]]

Returns:

Union[List[EdgeIndex], Dict[Group, List[EdgeIndex]]] –

Edge indices: associated with the specified group(s).

classmethod from_advanced_example_dataset()[source]#

Creates a MedRecord instance from an advanced example dataset.

The example dataset was created using the Synthea™ Patient Generator: synthetichealth/synthea, and it includes 600 patients with their diagnoses, prescriptions, procedures, and death events.

Return type:: MedRecord
Returns:: MedRecord – A new instance created from the advanced example dataset.

classmethod from_pandas(nodes, edges=None)[source]#

Creates a MedRecord from Pandas DataFrames of nodes and optionally edges.

Accepts a tuple or a list of tuples for nodes and edges. Each node tuple consists of a Pandas DataFrame and an index column. Edge tuples include a DataFrame and index columns for source and target nodes.

Parameters:

nodes (Union[PolarsNodeDataFrameInput, List[PolarsNodeDataFrameInput]]) – Node DataFrame(s).
edges (Optional[Union[PolarsEdgeDataFrameInput, List[PolarsEdgeDataFrameInput]]]) – Edge DataFrame(s), optional.

Return type:

MedRecord

Returns:

MedRecord – A new instance from the provided DataFrames.

classmethod from_polars(nodes, edges=None)[source]#

Creates a MedRecord from Polars DataFrames of nodes and optionally edges.

Accepts a tuple or a list of tuples for nodes and edges. Each node tuple consists of a Polars DataFrame and an index column. Edge tuples include a DataFrame and index columns for source and target nodes.

Parameters:

nodes (Union[PolarsNodeDataFrameInput, List[PolarsNodeDataFrameInput]]) – Node data.
edges (Optional[Union[PolarsEdgeDataFrameInput, List[PolarsEdgeDataFrameInput]]]) – Edge data, optional.

Return type:

MedRecord

Returns:

MedRecord – A new instance from the provided Polars DataFrames.

classmethod from_ron(path)[source]#

Creates a MedRecord instance from a RON file.

Reads node and edge data from a RON file specified by the path and creates a new MedRecord instance using this data.

Parameters:: path (str) – Path to the RON file.
Return type:: MedRecord
Returns:: MedRecord – A new instance created from the RON file.

classmethod from_simple_example_dataset()[source]#

Creates a MedRecord instance from a simple example dataset.

The example dataset was created using the Synthea™ Patient Generator: synthetichealth/synthea, and it includes 5 patients with their diagnoses, prescriptions and procedures.

Return type:: MedRecord
Returns:: MedRecord – A new instance created from the example dataset.

classmethod from_tuples(nodes, edges=None)[source]#

Creates a MedRecord instance from lists of node and edge tuples.

Nodes and edges are specified as lists of tuples. Each node tuple contains a node index and attributes. Each edge tuple includes indices of the source and target nodes and edge attributes.

Parameters:

nodes (Sequence[NodeTuple]) – Sequence of node tuples.
edges (Optional[Sequence[EdgeTuple]]) – Sequence of edge tuples.

Return type:

MedRecord

Returns:

MedRecord – A new instance created from the provided tuples.

group(group)[source]#

Returns the node and edge indices associated with the specified group/s.

If a single group is specified, returns a list of node and edge indices for that group. If multiple groups are specified, returns a dictionary with each group name mapping to its list of node and edge indices indices.

Parameters:

group (Union[Group, List[Group]]) – One or more group names.

Return type:

Union[GroupInfo, Dict[Union[str, int], GroupInfo]]

Returns:

Union[GroupInfo, Dict[Group, GroupInfo]] –

Node and edge indices for: the specified group(s).

group_count()[source]#

Returns the total number of groups currently defined within the MedRecord.

Return type:: int
Returns:: int – The total number of groups.

property groups: List[str | int]#

Lists the groups in the MedRecord instance.

Returns a list of all groups currently defined within the MedRecord instance.

Returns:: List[Group] – A list of groups.

groups_of_edge(edge)[source]#

Retrieves the groups associated with the specified edge(s) in the MedRecord.

If a single edge index is provided, returns a list of groups for that edge. If multiple edges are specified, returns a dictionary mapping each edge index to its list of groups.

Parameters:

edge (Union[EdgeIndex, EdgeIndexInputList, EdgeQuery]) – One or more edge indices or an edge query.

Return type:

Union[List[Union[str, int]], Dict[int, List[Union[str, int]]]]

Returns:

Union[List[Group], Dict[EdgeIndex, List[Group]]] –

Groups associated with: each edge.

groups_of_node(node)[source]#

Retrieves the groups associated with the specified node(s) in the MedRecord.

If a single node index is provided, returns a list of groups for that node. If multiple nodes are specified, returns a dictionary mapping each node index to its list of groups.

Parameters:

node (Union[NodeIndex, NodeIndexInputList, NodeQuery]) – One or more node indices or a node query.

Return type:

Union[List[Union[str, int]], Dict[Union[str, int], List[Union[str, int]]]]

Returns:

Union[List[Group], Dict[NodeIndex, List[Group]]] –

Groups associated with: each node.

incoming_edges(node)[source]#

Lists the incoming edges of the specified node(s) in the MedRecord.

If a single node index is provided, returns a list of its incoming edge indices. If multiple nodes are specified, returns a dictionary mapping each node index to its list of incoming edge indices.

Parameters:

node (Union[NodeIndex, NodeIndexInputList, NodeQuery]) – One or more node indices or a node query.

Return type:

Union[List[int], Dict[Union[str, int], List[int]]]

Returns:

Union[List[EdgeIndex], Dict[NodeIndex, List[EdgeIndex]]] –

Incoming: edge indices for each specified node.

neighbors(node, directed=EdgesDirected.DIRECTED)[source]#

Retrieves the neighbors of the specified node(s) in the MedRecord.

If a single node index is provided, returns a list of its neighboring node indices. If multiple nodes are specified, returns a dictionary mapping each node index to its list of neighboring nodes.

Parameters:

node (Union[NodeIndex, NodeIndexInputList, NodeQuery]) – One or more node indices or a node query.
directed (EdgesDirected, optional) – Whether to consider edges as directed. Defaults to EdgesDirected.DIRECTED.

Return type:

Union[List[Union[str, int]], Dict[Union[str, int], List[Union[str, int]]]]

Returns:

Union[List[NodeIndex], Dict[NodeIndex, List[NodeIndex]]] – Neighboring nodes.

property node: NodeIndexer#

Provides access to node attributes within the MedRecord via an indexer.

Facilitates querying, accessing, manipulating, and setting node attributes using various indexing methods. Supports conditions and ranges for more complex queries.

Returns:: NodeIndexer – An object for manipulating and querying node attributes.

node_count()[source]#

Returns the total number of nodes currently managed by the MedRecord.

Return type:: int
Returns:: int – The total number of nodes.

property nodes: List[str | int]#

Lists the node indices in the MedRecord instance.

Returns a list of all node indices currently managed by the MedRecord instance.

Returns:: List[NodeIndex] – A list of node indices.

nodes_in_group(group)[source]#

Retrieves the node indices associated with the specified group/s.

If a single group is specified, returns a list of node indices for that group. If multiple groups are specified, returns a dictionary mapping each group name to its list of node indices.

Parameters:

group (GroupInputList) – One or more group names.

Return type:

Union[List[Union[str, int]], Dict[Union[str, int], List[Union[str, int]]]]

Returns:

Union[List[NodeIndex], Dict[Group, List[NodeIndex]]] –

Node indices: associated with the specified group(s).

outgoing_edges(node)[source]#

Lists the outgoing edges of the specified node(s) in the MedRecord.

If a single node index is provided, returns a list of its outgoing edge indices. If multiple nodes are specified, returns a dictionary mapping each node index to its list of outgoing edge indices.

Parameters:

node (Union[NodeIndex, NodeIndexInputList, NodeQuery]) – One or more node indices or a node query.

Return type:

Union[List[int], Dict[Union[str, int], List[int]]]

Returns:

Union[List[EdgeIndex], Dict[NodeIndex, List[EdgeIndex]]] –

Outgoing: edge indices for each specified node.

overview_edges(groups=None, decimal=2)[source]#

Gets a summary for all edges in groups and their attributes.

Parameters:

groups (Optional[Union[Group, GroupInputList]], optional) – Group or list of edge groups to display. If no groups are given, all groups containing nodes are shown. Defaults to None.
decimal (int, optional) – Decimal point to round the float values to. Defaults to 2.

Return type:

OverviewTable

Returns:

OverviewTable – Display of edge groups and their attributes.

Example

--------------------------------------------------------------------------
Edges Group       Count Attribute      Type       Data
--------------------------------------------------------------------------
Patient-Diagnosis 60    diagnosis_time Temporal   min: 1962-10-21 00:00:00
                                                  max: 2024-04-12 00:00:00
                        duration_days  Continuous min: 0
                                                  max: 3416
                                                  mean: 405.02
--------------------------------------------------------------------------

overview_nodes(groups=None, decimal=2)[source]#

Gets a summary for all nodes in groups and their attributes.

Parameters:

groups (Optional[Union[Group, GroupInputList]], optional) – Group or list of node groups to display. If no groups are given, all groups containing nodes are shown. Defaults to None.
decimal (int, optional) – Decimal point to round the float values to. Defaults to 2.

Return type:

OverviewTable

Returns:

OverviewTable – Display of edge groups and their attributes.

Example

--------------------------------------------------------------
Nodes Group     Count Attribute   Type        Data
--------------------------------------------------------------
diagnosis       25    description Categorical 25 unique values
patient         5     age         Continuous  min: 19
                                              max: 96
                                              mean: 43.20
                      gender      Categorical Categories: F, M
Ungrouped Nodes 10    -           -           -
--------------------------------------------------------------

remove_edges(edges)[source]#

Removes edges from the MedRecord and returns their attributes.

If a single edge index is provided, returns the attributes of the removed edge. If multiple edge indices are specified, returns a dictionary mapping each edge index to its attributes.

Parameters:

edges (Union[EdgeIndex, EdgeIndexInputList, EdgeQuery]) – One or more edge indices or an edge query.

Return type:

Union[Dict[Union[str, int], Union[str, int, float, bool, datetime, timedelta, None]], Dict[int, Dict[Union[str, int], Union[str, int, float, bool, datetime, timedelta, None]]]]

Returns:

Union[Attributes, Dict[EdgeIndex, Attributes]] –

Attributes of the: removed edge(s).

remove_edges_from_group(group, edges)[source]#

Removes one or more edges from a specified group in the MedRecord.

Parameters:

group (Group) – The name of the group from which to remove edges.
edges (Union[EdgeIndex, EdgeIndexInputList, EdgeQuery]) – One or more edge indices or an edge query to remove from the group.

Return type:

None

Returns:

None

remove_groups(groups)[source]#

Removes one or more groups from the MedRecord instance.

Parameters:: groups (Union[Group, GroupInputList]) – One or more group names to remove.
Return type:: None
Returns:: None

remove_nodes(nodes)[source]#

Removes nodes from the MedRecord and returns their attributes.

If a single node index is provided, returns the attributes of the removed node. If multiple node indices are specified, returns a dictionary mapping each node index to its attributes.

Parameters:

nodes (Union[NodeIndex, NodeIndexInputList, NodeQuery]) – One or more node indices or a node query.

Return type:

Union[Dict[Union[str, int], Union[str, int, float, bool, datetime, timedelta, None]], Dict[Union[str, int], Dict[Union[str, int], Union[str, int, float, bool, datetime, timedelta, None]]]]

Returns:

Union[Attributes, Dict[NodeIndex, Attributes]] –

Attributes of the: removed node(s).

remove_nodes_from_group(group, nodes)[source]#

Removes one or more nodes from a specified group in the MedRecord.

Parameters:

group (Group) – The name of the group from which to remove nodes.
nodes (Union[NodeIndex, NodeIndexInputList, NodeQuery]) – One or more node indices or a node query to remove from the group.

Return type:

None

Returns:

None

property schema: Schema#

Returns the schema of the MedRecord instance.

Returns:: Schema – The schema of the MedRecord.

select_edges(query)[source]#

Selects edges from the MedRecord based on the provided query.

Parameters:: query (EdgeQuery) – A query to filter edges.
Return type:: List[int]
Returns:: List[EdgeIndex] – A list of edge indices that satisfy the query.

select_nodes(query)[source]#

Selects nodes from the MedRecord based on the provided query.

Parameters:: query (NodeQuery) – A query to filter nodes.
Return type:: List[Union[str, int]]
Returns:: List[NodeIndex] – A list of node indices that satisfy the query.

to_ron(path)[source]#

Writes the MedRecord instance to a RON file.

Serializes the MedRecord instance to a RON file at the specified path.

Parameters:: path (str) – Path where the RON file will be written.
Return type:: None

classmethod with_schema(schema)[source]#

Creates a MedRecord instance with the specified schema.

Parameters:: schema (Schema) – The schema to apply to the MedRecord.
Return type:: MedRecord
Returns:: MedRecord – A new instance with the provided schema.