From b17d2860e80e59a0b8c0f2423e8cb47aebf1902a Mon Sep 17 00:00:00 2001
From: RavenMarQ <ravenmq@hawaii.edu>
Date: Thu, 3 Oct 2024 03:11:23 -1000
Subject: [PATCH] Working On Creating Notebook

Updating NAMESPACE to export the new functions and creating the Rmd, are the primary notes. The folder holding the sample project also is included locally, but uses the calculator project provided in Issue from Carlos
---
 NAMESPACE                         |  2 +
 R/src.R                           |  2 +-
 vignettes/understand_showcase.Rmd | 65 +++++++++++++++++++++++++++++++
 3 files changed, 68 insertions(+), 1 deletion(-)
 create mode 100644 vignettes/understand_showcase.Rmd

diff --git a/NAMESPACE b/NAMESPACE
index 2e3b17bf..3af220f6 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -157,6 +157,8 @@ export(transform_gitlog_to_temporal_network)
 export(transform_r_dependencies_to_network)
 export(transform_reply_to_bipartite_network)
 export(transform_temporal_gitlog_to_adsmj)
+export(transform_und_dependencies_to_network)
+export(understand_parse_dependencies)
 export(weight_scheme_count_deleted_nodes)
 export(weight_scheme_cum_temporal)
 export(weight_scheme_pairwise_cum_temporal)
diff --git a/R/src.R b/R/src.R
index 2b4ffdab..aee650dd 100644
--- a/R/src.R
+++ b/R/src.R
@@ -315,7 +315,7 @@ parse_r_dependencies <- function(folder_path){
 #'
 #' @export
 #' @family edgelists
-transform_und_class_dependencies_to_network <- function(parsed, weight_types) {
+transform_und_dependencies_to_network <- function(parsed, weight_types) {
 
   nodes <- parsed[["node_list"]]
   edges <- parsed[["edge_list"]]
diff --git a/vignettes/understand_showcase.Rmd b/vignettes/understand_showcase.Rmd
new file mode 100644
index 00000000..568da759
--- /dev/null
+++ b/vignettes/understand_showcase.Rmd
@@ -0,0 +1,65 @@
+---
+title: "Understand Showcase"
+output: 
+  html_document:
+    toc: true
+    number_sections: true
+vignette: >
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteIndexEntry{Understand Showcase}
+  %\VignetteEncoding{UTF-8}
+---
+
+
+```{r warning = FALSE, message = FALSE}
+rm(list = ls())
+library(kaiaulu)
+library(visNetwork)
+library(igraph)
+library(data.table)
+```
+
+
+# Parse a sample project folder
+
+```{r}
+folder_path <- "../tests/sample_project"
+```
+
+
+# File Dependencies
+
+```{r}
+file_dependencies <- understand_parse_dependencies(project_path = folder_path, language = "java", parse_type = "file")
+head(file_dependencies)
+```
+
+
+# Class Dependencies
+
+```{r}
+class_dependencies <- understand_parse_dependencies(project_path = folder_path, language = "java", parse_type = "class")
+head(class_dependencies)
+```
+
+## File
+
+```{r}
+file_graph <- transform_und_dependencies_to_network(parsed = file_dependencies, weight_types = c("", ""))
+project_function_network <- igraph::graph_from_data_frame(d=function_graph[["edgelist"]], 
+                      directed = TRUE,
+                      vertices = function_graph[["nodes"]])
+visIgraph(project_function_network,randomSeed = 1)
+```
+
+
+## Class
+
+```{r}
+class_graph <- transform_und_dependencies_to_network(parsed = class_dependencies, weight_types = c("", ""))
+project_function_network <- igraph::graph_from_data_frame(d=file_graph[["edgelist"]], 
+                      directed = TRUE,
+                      vertices = file_graph[["nodes"]])
+visIgraph(project_function_network,randomSeed = 1)
+```
+