Skip to content

Commit 28a8c2c

Browse files
committed
Automated scripts reference document generation (CI)
1 parent ea36b63 commit 28a8c2c

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

scripts/SCRIPTS.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,15 @@ Script | Directory | Description
5050
| [CentralityCsv.sh](./reports/CentralityCsv.sh) | reports | Looks for centrality using the Graph Data Science Library of Neo4j and creates CSV reports. |
5151
| [CommunityCsv.sh](./reports/CommunityCsv.sh) | reports | Detects communities using the Graph Data Science Library of Neo4j and creates CSV reports. |
5252
| [ExternalDependenciesCsv.sh](./reports/ExternalDependenciesCsv.sh) | reports | Executes "External_Dependencies" Cypher queries to get the "external-dependencies-csv" CSV reports. |
53-
| [GraphVisualization.sh](./reports/GraphVisualization.sh) | reports | Creates the "graph-visualization" report (ipynb, md, pdf) based on the Jupyter Notebook "ArtifactDependencies.ipynb". |
53+
| [GraphVisualization.sh](./reports/GraphVisualization.sh) | reports | DEPRECATED: Creates the "graph-visualization" report using the (now deprecated) nodejs project "graph-visualization". |
5454
| [InternalDependenciesCsv.sh](./reports/InternalDependenciesCsv.sh) | reports | Executes "Internal_Dependencies" Cypher queries to get the "internal-dependencies-csv" CSV reports. |
55+
| [InternalDependenciesVisualization.sh](./reports/InternalDependenciesVisualization.sh) | reports | Executes selected "Internal_Dependencies" Cypher queries for GraphViz visualization. |
5556
| [JavaCsv.sh](./reports/JavaCsv.sh) | reports | Executes "Java" Cypher queries to get the "java-csv" CSV reports. |
5657
| [NodeEmbeddingsCsv.sh](./reports/NodeEmbeddingsCsv.sh) | reports | Generates node embeddings using the Graph Data Science Library of Neo4j and creates CSV reports. |
5758
| [ObjectOrientedDesignMetricsCsv.sh](./reports/ObjectOrientedDesignMetricsCsv.sh) | reports | Executes "Metrics" Cypher queries to get the "object-oriented-design-metrics-csv" CSV reports. |
5859
| [OverviewCsv.sh](./reports/OverviewCsv.sh) | reports | Executes "Overview" Cypher queries to get the "overview-csv" CSV reports. |
5960
| [PathFindingCsv.sh](./reports/PathFindingCsv.sh) | reports | Uses path finding algorithms from the Graph Data Science Library of Neo4j and creates CSV reports. |
61+
| [PathFindingVisualization.sh](./reports/PathFindingVisualization.sh) | reports | Executes selected "Path_Finding" Cypher queries for GraphViz visualization. |
6062
| [SimilarityCsv.sh](./reports/SimilarityCsv.sh) | reports | Looks for similarity using the Graph Data Science Library of Neo4j and creates CSV reports. |
6163
| [TopologicalSortCsv.sh](./reports/TopologicalSortCsv.sh) | reports | Applies the Topological Sorting algorithm for directed acyclic graphs (DAG) to order code units by their dependencies |
6264
| [VisibilityMetricsCsv.sh](./reports/VisibilityMetricsCsv.sh) | reports | Executes "Visibility" Cypher queries to get the "visibility-metrics-csv" CSV reports. |
@@ -74,4 +76,6 @@ Script | Directory | Description
7476
| [sortOutExternalJavaJarFiles.sh](./sortOutExternalJavaJarFiles.sh) | | Sorts out jar files that don't contain one of the given package names (e.g. external libraries) and moves them into the IGNORED_JARS_DIRECTORY. |
7577
| [startNeo4j.sh](./startNeo4j.sh) | | Starts the local Neo4j Graph Database. |
7678
| [stopNeo4j.sh](./stopNeo4j.sh) | | Stops the local Neo4j Graph Database. |
79+
| [convertQueryResultCsvToGraphVizDotFile.sh](./visualization/convertQueryResultCsvToGraphVizDotFile.sh) | visualization | Converts a Cypher query result in CSV format to a GraphViz DOT (https://graphviz.org/doc/info/lang.html) file for Visualization including layout templates. |
80+
| [visualizeQueryResults.sh](./visualization/visualizeQueryResults.sh) | visualization | Visualizes the Cypher query result (CSV format) using GraphViz and outputs it as SVG image. |
7781
| [waitForNeo4jHttpFunctions.sh](./waitForNeo4jHttpFunctions.sh) | | Waits until the HTTP Transactions API of Neo4j Graph Database is available. |

0 commit comments

Comments
 (0)