Summarize contents of a Neo4j KG engine — summary.neo4j

Given a Neo4j based KG engine, provides summary information in the form of node counts, category counts across nodes, relationship type counts, and available properties. General information about the graph is printed to the console, and a list of dataframes with this information is returned invisibly. Also returned are cats, preds, and props entries, containing lists of available categories/predicates/properties for convenient auto-completion in RStudio.

# S3 method for class 'neo4j_engine'
summary(object, ..., quiet = FALSE)

Arguments

object: A neo4j_engine object
...: Other parameters (not used)
quiet: Logical, whether to suppress printing of the summary

Value

A list of dataframes and named lists

Examples

if (FALSE) {
# prints a readable summary and returns a list of dataframes
stats <- monarch_engine() |> summary()
print(stats)
}