getRelationshipAttributes: Get the attributes of the relationships connecting two nodes,...

In frankkramer-lab/Multipath2Neo4j: A package for collecting, modeling, visualizing and storing biological pathways networks in Neo4j

Get the attributes of the relationships connecting two nodes, or all nodes in a Neo4j graph

Description

Get the attributes of the relationships connecting two nodes, or all nodes in a Neo4j graph

Usage

getRelationshipAttributes(
  connection,
  returned_started_node_property,
  returned_end_node_property,
  started_node_property = NULL,
  started_node_property_value = NULL,
  end_node_property = NULL,
  end_node_property_value = NULL
)

Arguments

connection	The Neo4j connection object.
returned_started_node_property	The name of the attribute identifying the started node.
returned_end_node_property	The name of the attribute identifying the end node.
started_node_property	The started node property key name to be identified by.
started_node_property_value	The started node property key value to be found within.
end_node_property	The end node property key name to be identified by.
end_node_property_value	The end node property key value to be found within.

Value

A dataframe containing the relationships with their attributes. If both nodes' properties and values are missing, it returns all the relationships with their attributes. If the started node's property name and value are given, it returns all the relationships starting from this node. If the end node's property name and value are given, it returns all the relationships ending with this node.

Examples

## Not run: 
#To get all the edges with their attributes
edges = getRelationshipAttributes(connection, "name", "name")

#To get all the edges starting from the node of name Complex1 with their attributes
edges = getRelationshipAttributes(connection, "name", "name", "name", "Complex1")

#To get all the edges ending with the node of name Complex10 with their attributes
edges = getRelationshipAttributes(connection, "name", "name",
end_node_property = "name", end_node_property_value = "Complex10")

## End(Not run)

frankkramer-lab/Multipath2Neo4j documentation built on July 20, 2023, 11:43 p.m.