% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/generate_curricular_complexity_scorecard.R
\name{generate_curricular_complexity_scorecard}
\alias{generate_curricular_complexity_scorecard}
\title{Generate a scorecard of curricular complexity metrics}
\usage{
generate_curricular_complexity_scorecard(plan_of_study, include_coreqs = TRUE)
}
\arguments{
\item{plan_of_study}{An igraph object representing a plan of study,
created using the \code{\link{create_plan_of_study}} function.}

\item{include_coreqs}{A logical value indicating whether corequisite
courses should be included when calculating course-level metrics and
structural complexity.}
}
\value{
A list containing two elements:
  \describe{
    \item{CourseLevel}{A data frame containing the course-level metrics
      \code{Course}, \code{Blocking}, \code{Reachability}, \code{Delay},
      \code{Cruciality}, \code{Deferment}, and \code{Bottleneck}. An
      asterisk in the \code{Bottleneck} column indicates that the course
      was identified as a bottleneck.}
    \item{CurriculumLevel}{A named vector containing the curriculum-level
      metrics \code{StructuralComplexity}, \code{CurricularRigidity}, and
      \code{TotalBottlenecks}.}
  }
}
\description{
This function calculates course-level and curriculum-level curricular
complexity metrics for a plan of study. Course-level metrics include
blocking, reachability, delay, cruciality, deferment, and bottleneck
status. Curriculum-level metrics include structural complexity,
curricular rigidity, and the total number of bottleneck courses.
}
