R/summary.CohortRetention.r

In jbryer/retention: Retention and Completion for Higher Education

#' Prints summary of \code{\link{cohortRetention}}.
#' 
#' @param months the months to include in the summary.
#' @param ... currenlty unused.
#' @export
summary.CohortRetention <- function(object, 
									months=c(15, 36, 48, 72, 96), 
									...) {
	dr = object$Summary
	s = data.frame()
	if(is.null(object$grouping)) {
		s = data.frame(Month=numeric, Cohort=character(), RetentionRate=numeric(), 
					   GraduationRate=numeric(), Enrollments=integer())
		for(m in months) {
			s = rbind(s, dr[which(dr$Month == m),names(s)])
		}
	} else {
		s = data.frame(Month=numeric, Cohort=character(), 
					   Group=character(), RetentionRate=numeric(), 
					   GraduationRate=numeric(), Enrollments=integer())
		for(m in months) {
			s = rbind(s, dr[which(dr$Month == m),names(s)])
		}
	}
	row.names(s) = 1:nrow(s)
	return(s)
}