Merge pull request #145 from CurricularAnalytics/add_credit_balance

Add credit balance
CurricularAnalytics · Jun 12, 2024 · d677b0f · d677b0f · haydenfree · Jun 12, 2024
2 parents 8b9d0af + 993b1a4
commit d677b0f
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "CurricularAnalytics"
 uuid = "593ffa3d-269e-5d81-88bc-c3b6809c35a6"
 authors = ["Greg Heileman <[email protected]>", "Hayden Free <[email protected]>"]
-version = "1.5.0"
+version = "1.5.1"
 
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"

diff --git a/src/CurricularAnalytics.jl b/src/CurricularAnalytics.jl
@@ -26,14 +26,14 @@ include("DegreePlanCreation.jl")
 include("Simulation/Simulation.jl")
 include("RequirementsAnalytics.jl")
 
-export AA, AAS, AS, AbstractCourse, AbstractRequirement, BA, BS, Course, CourseCollection, CourseCatalog, CourseRecord, CourseSet, Curriculum, DegreePlan, 
+export AA, AAS, AS, AbstractCourse, AbstractRequirement, BA, BS, Course, CourseCollection, CourseCatalog, CourseRecord, CourseSet, credit_balance, Curriculum, DegreePlan, 
         EdgeClass, Enrollment, Grade, LearningOutcome, PassRate, RequirementSet, Requisite, Student, StudentRecord, Simulation, System, Term, TransferArticulation,
         add_course!, add_lo_requisite!, add_requisite!, add_transfer_catalog, add_transfer_course, all_paths, back_edge, basic_metrics, basic_statistics, 
         bin_filling, blocking_factor, centrality, co, compare_curricula, convert_ids, complexity, course, course_from_id, course_from_vertex, course_id, 
         courses_from_vertices, create_degree_plan, cross_edge, dead_ends, delay_factor, delete_requisite!, dfs, extraneous_requisites, find_term, forward_edge, 
         gad, grade, homology, is_duplicate, is_valid, isvalid_curriculum, isvalid_degree_plan, level, longest_path, longest_paths, merge_curricula, pass_table, passrate_table, 
         pre, postorder_traversal, preorder_traversal, print_plan, quarter, reach, reach_subgraph, reachable_from, reachable_from_subgraph, reachable_to, reachable_to_subgraph, 
-        read_csv, requisite_distance,requisite_type, semester, set_passrates, set_passrate_for_course, set_passrates_from_csv, show_requirements, similarity, simple_students, 
+        read_csv, requisite_distance, requisite_type, semester, set_passrates, set_passrate_for_course, set_passrates_from_csv, show_requirements, similarity, simple_students, 
         simulate, simulation_report, strict_co, topological_sort, total_credits, transfer_equiv, tree_edge, write_csv, knowledge_transfer, csv_stream
 
 """

diff --git a/src/DegreePlanAnalytics.jl b/src/DegreePlanAnalytics.jl
@@ -138,4 +138,15 @@ function requisite_distance(plan::DegreePlan)
         distance = distance + requisite_distance(plan, c)
     end
     return plan.metrics["requisite distance"] = distance
+end
+
+#TODO: write docstring, write tests
+function credit_balance(plan::DegreePlan)
+    bal = 0
+    for i in 1:length(plan.terms)-1
+        for j in i+1:length(plan.terms)
+            bal += abs(plan.terms[i].credit_hours - plan.terms[j].credit_hours)
+        end
+    end
+    return bal
 end