Automated cypher reference document generation (CI)

Author: JohT

cypher/CYPHER.md

@@ -64,6 +64,11 @@ Script | Directory | Description
 | [Community_Detection_10d_LocalClusteringCoefficient_Stream.cypher](./Community_Detection/Community_Detection_10d_LocalClusteringCoefficient_Stream.cypher) | Community_Detection | Community Detection - Local Clustering Coefficient - Stream |
 | [Community_Detection_10d_LocalClusteringCoefficient_Stream_Aggregated.cypher](./Community_Detection/Community_Detection_10d_LocalClusteringCoefficient_Stream_Aggregated.cypher) | Community_Detection | Community Detection - Local Clustering Coefficient - Stream Aggregated |
 | [Community_Detection_10e_LocalClusteringCoefficient_Write.cypher](./Community_Detection/Community_Detection_10e_LocalClusteringCoefficient_Write.cypher) | Community_Detection | Community Detection - Local Clustering Coefficient - Write |
+| [Community_Detection_11a_HDBSCAN_Estimate.cypher](./Community_Detection/Community_Detection_11a_HDBSCAN_Estimate.cypher) | Community_Detection | Community Detection: Hierarchical Density-Based Spatial Clustering (HDBSCAN) - Estimate |
+| [Community_Detection_11b_HDBSCAN_Statistics.cypher](./Community_Detection/Community_Detection_11b_HDBSCAN_Statistics.cypher) | Community_Detection | Community Detection: Hierarchical Density-Based Spatial Clustering (HDBSCAN) - Statistics |
+| [Community_Detection_11c_HDBSCAN_Mutate.cypher](./Community_Detection/Community_Detection_11c_HDBSCAN_Mutate.cypher) | Community_Detection | Community Detection: Hierarchical Density-Based Spatial Clustering (HDBSCAN) - Mutate |
+| [Community_Detection_11d_HDBSCAN_Stream.cypher](./Community_Detection/Community_Detection_11d_HDBSCAN_Stream.cypher) | Community_Detection | Community Detection: Hierarchical Density-Based Spatial Clustering (HDBSCAN) - Stream |
+| [Community_Detection_11e_HDBSCAN_Write.cypher](./Community_Detection/Community_Detection_11e_HDBSCAN_Write.cypher) | Community_Detection | Community Detection: Hierarchical Density-Based Spatial Clustering (HDBSCAN) - write node property e.g. communityHdbscanLabel |
 | [Community_Detection_1a_Louvain_Estimate.cypher](./Community_Detection/Community_Detection_1a_Louvain_Estimate.cypher) | Community_Detection | Community Detection Louvain Estimate Memory |
 | [Community_Detection_1b_Louvain_Statistics.cypher](./Community_Detection/Community_Detection_1b_Louvain_Statistics.cypher) | Community_Detection | Community Detection Louvain Statistics |
 | [Community_Detection_1c_Louvain_Mutate.cypher](./Community_Detection/Community_Detection_1c_Louvain_Mutate.cypher) | Community_Detection | Community Detection Louvain Mutate |
@@ -73,8 +78,10 @@ Script | Directory | Description
 | [Community_Detection_1e_Louvain_Write_louvainCommunityId.cypher](./Community_Detection/Community_Detection_1e_Louvain_Write_louvainCommunityId.cypher) | Community_Detection | Community Detection Louvain write node property communityLouvainId |
 | [Community_Detection_2a_Leiden_Estimate.cypher](./Community_Detection/Community_Detection_2a_Leiden_Estimate.cypher) | Community_Detection | Community Detection Leiden Estimate Memory |
 | [Community_Detection_2b_Leiden_Statistics.cypher](./Community_Detection/Community_Detection_2b_Leiden_Statistics.cypher) | Community_Detection | Community Detection Leiden Statistics |
+| [Community_Detection_2b_Leiden_Tuneable_Statistics.cypher](./Community_Detection/Community_Detection_2b_Leiden_Tuneable_Statistics.cypher) | Community_Detection | Community Detection Leiden Statistics |
 | [Community_Detection_2c_Leiden_Mutate.cypher](./Community_Detection/Community_Detection_2c_Leiden_Mutate.cypher) | Community_Detection | Community Detection Leiden Mutate |
 | [Community_Detection_2d_Leiden_Stream.cypher](./Community_Detection/Community_Detection_2d_Leiden_Stream.cypher) | Community_Detection | Community Detection Leiden Stream |
+| [Community_Detection_2d_Leiden_Tuneable_Write.cypher](./Community_Detection/Community_Detection_2d_Leiden_Tuneable_Write.cypher) | Community_Detection | Community Detection Leiden Write property communityLeidenId |
 | [Community_Detection_2d_Leiden_Write_Node_Property.cypher](./Community_Detection/Community_Detection_2d_Leiden_Write_Node_Property.cypher) | Community_Detection | Community Detection Leiden Write property communityLeidenId |
 | [Community_Detection_3a_WeaklyConnectedComponents_Estimate.cypher](./Community_Detection/Community_Detection_3a_WeaklyConnectedComponents_Estimate.cypher) | Community_Detection | Community Detection Label Propagation Estimate |
 | [Community_Detection_3b_WeaklyConnectedComponents_Statistics.cypher](./Community_Detection/Community_Detection_3b_WeaklyConnectedComponents_Statistics.cypher) | Community_Detection | Community Detection Weakly Connected Components Statistics |
@@ -130,6 +137,8 @@ Script | Directory | Description
 | [Dependencies_10_Delete_Label.cypher](./Dependencies_Projection/Dependencies_10_Delete_Label.cypher) | Dependencies_Projection | Community Detection Label Propagation Label Delete |
 | [Dependencies_11_Add_Label.cypher](./Dependencies_Projection/Dependencies_11_Add_Label.cypher) | Dependencies_Projection | Write a property from the projection into the Graph. Variables: dependencies_projection, dependencies_projection_write_property |
 | [Dependencies_12_Get_Projection_Statistics.cypher](./Dependencies_Projection/Dependencies_12_Get_Projection_Statistics.cypher) | Dependencies_Projection | Get dependency projection statistics |
+| [Dependencies_13_Sample_Projected_Graph.cypher](./Dependencies_Projection/Dependencies_13_Sample_Projected_Graph.cypher) | Dependencies_Projection | Creates a smaller projection by sampling the original graph using "Common Neighbour Aware Random Walk" |
+| [Dependencies_14_Write_Batch_Data.cypher](./Dependencies_Projection/Dependencies_14_Write_Batch_Data.cypher) | Dependencies_Projection | Writes batch data back into the database for code units when working with a dependencies projection. Variables: dependencies_projection_rows, dependencies_projection_node |
 | [Dependencies_1_Delete_Projection.cypher](./Dependencies_Projection/Dependencies_1_Delete_Projection.cypher) | Dependencies_Projection | Delete projection if existing. Variables: dependencies_projection |
 | [Dependencies_2_Delete_Subgraph.cypher](./Dependencies_Projection/Dependencies_2_Delete_Subgraph.cypher) | Dependencies_Projection | Delete filtered subgraph projection if exists. Variables: dependencies_projection |
 | [Dependencies_3_Create_Projection.cypher](./Dependencies_Projection/Dependencies_3_Create_Projection.cypher) | Dependencies_Projection | Create directed projection. Variables: dependencies_projection, dependencies_projection_node, dependencies_projection_weight_property |
@@ -164,6 +173,7 @@ Script | Directory | Description
 | [Explore_degree_schema.cypher](./Exploration/Explore_degree_schema.cypher) | Exploration | Explore incoming/outgoing relationship (degree) schema |
 | [Explore_external_Typescript_dependencies.cypher](./Exploration/Explore_external_Typescript_dependencies.cypher) | Exploration | Explore Typescript nodes with globalFqn property by their label, count and if they came from the node_modules folder |
 | [Explore_node_properties.cypher](./Exploration/Explore_node_properties.cypher) | Exploration | Explore node properties, the labels of their nodes and their count |
+| [Explore_node_properties_non_null.cypher](./Exploration/Explore_node_properties_non_null.cypher) | Exploration | Explore non null node property counts for the selected node label. Variables: projection_node_label |
 | [Explore_node_relationships.cypher](./Exploration/Explore_node_relationships.cypher) | Exploration | Get all relationships of one specific node to explore the schema |
 | [Export_the_whole_database_as_CSV.cypher](./Export_the_whole_database_as_CSV.cypher) |  | Export the whole database as CSV |
 | [External_module_usage_overall_for_Typescript.cypher](./External_Dependencies/External_module_usage_overall_for_Typescript.cypher) | External_Dependencies | External Typescript module usage overall |
@@ -315,13 +325,17 @@ Script | Directory | Description
 | [Node_Embeddings_1b_Fast_Random_Projection_Statistics.cypher](./Node_Embeddings/Node_Embeddings_1b_Fast_Random_Projection_Statistics.cypher) | Node_Embeddings | Node Embeddings 1b using Fast Random Projection: Statistics |
 | [Node_Embeddings_1c_Fast_Random_Projection_Mutate.cypher](./Node_Embeddings/Node_Embeddings_1c_Fast_Random_Projection_Mutate.cypher) | Node_Embeddings | Node Embeddings 1c using Fast Random Projection: Mutate |
 | [Node_Embeddings_1d_Fast_Random_Projection_Stream.cypher](./Node_Embeddings/Node_Embeddings_1d_Fast_Random_Projection_Stream.cypher) | Node_Embeddings | Node Embeddings 1d using Fast Random Projection: Stream. Requires "Add_file_name and_extension.cypher". |
+| [Node_Embeddings_1d_Fast_Random_Projection_Tuneable_Stream.cypher](./Node_Embeddings/Node_Embeddings_1d_Fast_Random_Projection_Tuneable_Stream.cypher) | Node_Embeddings | Node Embeddings 1d using Fast Random Projection: Stream for Hyper-Parameter tuning. Requires "Add_file_name and_extension.cypher". |
+| [Node_Embeddings_1e_Fast_Random_Projection_Tuneable_Write.cypher](./Node_Embeddings/Node_Embeddings_1e_Fast_Random_Projection_Tuneable_Write.cypher) | Node_Embeddings | Node Embeddings 1e using Fast Random Projection: Write for tuned hyper-parameters. |
 | [Node_Embeddings_1e_Fast_Random_Projection_Write.cypher](./Node_Embeddings/Node_Embeddings_1e_Fast_Random_Projection_Write.cypher) | Node_Embeddings | Node Embeddings 1d using Fast Random Projection: Write |
 | [Node_Embeddings_2a_Hash_GNN_Estimate.cypher](./Node_Embeddings/Node_Embeddings_2a_Hash_GNN_Estimate.cypher) | Node_Embeddings | Node Embeddings 2a using Hash GNN (Graph Neural Networks): Estimate |
 | [Node_Embeddings_2c_Hash_GNN_Mutate.cypher](./Node_Embeddings/Node_Embeddings_2c_Hash_GNN_Mutate.cypher) | Node_Embeddings | Node Embeddings 2b using Hash GNN (Graph Neural Networks): Mutate |
 | [Node_Embeddings_2d_Hash_GNN_Stream.cypher](./Node_Embeddings/Node_Embeddings_2d_Hash_GNN_Stream.cypher) | Node_Embeddings | Node Embeddings 2c using Hash GNN (Graph Neural Networks): Stream. Requires "Add_file_name and_extension.cypher". |
+| [Node_Embeddings_2d_Hash_GNN_Tuneable_Stream.cypher](./Node_Embeddings/Node_Embeddings_2d_Hash_GNN_Tuneable_Stream.cypher) | Node_Embeddings | Node Embeddings 2c using Hash GNN (Graph Neural Networks): Stream. Requires "Add_file_name and_extension.cypher". |
 | [Node_Embeddings_3a_Node2Vec_Estimate.cypher](./Node_Embeddings/Node_Embeddings_3a_Node2Vec_Estimate.cypher) | Node_Embeddings | Node Embeddings 3a using Node2Vec: Estimate |
 | [Node_Embeddings_3c_Node2Vec_Mutate.cypher](./Node_Embeddings/Node_Embeddings_3c_Node2Vec_Mutate.cypher) | Node_Embeddings | Node Embeddings 3c using Node2Vec: Mutate |
 | [Node_Embeddings_3d_Node2Vec_Stream.cypher](./Node_Embeddings/Node_Embeddings_3d_Node2Vec_Stream.cypher) | Node_Embeddings | Node Embeddings 3c using Node2Vec: Stream. Requires "Add_file_name and_extension.cypher". |
+| [Node_Embeddings_3d_Node2Vec_Tuneable_Stream.cypher](./Node_Embeddings/Node_Embeddings_3d_Node2Vec_Tuneable_Stream.cypher) | Node_Embeddings | Node Embeddings 3c using Node2Vec: Stream. Requires "Add_file_name and_extension.cypher". |
 | [Node_Embeddings_3e_Node2Vec_Write.cypher](./Node_Embeddings/Node_Embeddings_3e_Node2Vec_Write.cypher) | Node_Embeddings | Node Embeddings 3d using Node2Vec: Write |
 | [Set_Parameters.cypher](./Node_Embeddings/Set_Parameters.cypher) | Node_Embeddings | Example on how to set the parameters for node embeddings in this case for Packages and Node2Vec |
 | [Cyclomatic_Method_Complexity_Distribution.cypher](./Overview/Cyclomatic_Method_Complexity_Distribution.cypher) | Overview | Cyclomatic Complexity Method Complexity Distribution |
@@ -388,6 +402,7 @@ Script | Directory | Description
 | [Remove_duplicate_CONTAINS_relations_between_files.cypher](./Typescript_Enrichment/Remove_duplicate_CONTAINS_relations_between_files.cypher) | Typescript_Enrichment | Remove duplicate CONTAINS relationships with the same properties between files |
 | [Set_localRootPath_for_modules.cypher](./Typescript_Enrichment/Set_localRootPath_for_modules.cypher) | Typescript_Enrichment | Set "rootProjectName" and some local path properties for Typescript modules |
 | [Verify_projects_linked_to_npm_packages.cypher](./Typescript_Enrichment/Verify_projects_linked_to_npm_packages.cypher) | Typescript_Enrichment | Verify that all Typescript projects are linked to npm packages |
+| [ValidateAlwaysFalse.cypher](./Validation/ValidateAlwaysFalse.cypher) | Validation | Will never return any results so that the validation will always fail. This is helpful for Jupyter Notebooks that should not be executed automatically. |
 | [ValidateGitHistory.cypher](./Validation/ValidateGitHistory.cypher) | Validation | Check if there is at least one Git:Commit pointing to a Git:Change containing a Git:File from a Git:Repository |
 | [ValidateJavaArtifactDependencies.cypher](./Validation/ValidateJavaArtifactDependencies.cypher) | Validation | Check if there is at least one Java Artifact dependency. |
 | [ValidateJavaExternalDependencies.cypher](./Validation/ValidateJavaExternalDependencies.cypher) | Validation | Check if there is at least one external Java Type dependency. |