retention: Estimates retention.

In jbryer/retention: Retention and Completion for Higher Education

Description

Estimates retention.

Usage

retention(students, grads, studentIdColumn = "CONTACT_ID_SEQ",
  degreeColumn = "DEGREE_CODE", persistColumn = "PERSIST_FLAG",
  warehouseDateColumn = "CREATED_DATE", gradColumn = "START_DATE",
  grouping = NULL, ...)

Arguments

...	other parameters passed to cohortRetention function.
students	a data frame of enrolled students. This data frame should be structured like a warehouse data where a student is represented for each cohort (i.e. warehouseDateColumn) in which they are enrolled.
studentIdColumn	the name of the column corresponding the student's id.
degreeColumn	(optional) the name of the column corresponding to the degree the student is enrolled in (within students) or graduated (within graduates). If omitted, then Transferred and Graduated Other levels in the returned Status variable will have no values set.
persistColumn	(optional) the name of the column correspondinng to whether the student is persisting within that month or not. If omitted, the Persisting column will not be present in the returned data frame. The column must be logical.
warehouseDateColumn	the name of the column corresponding to the warehouse date, or cohort. Each unique date will thereby define a cohort.
gradColumn	the name of the column in the graduates data frame corresponding to the graduation date.

See Also

cohortRetention

jbryer/retention documentation built on May 18, 2019, 7:03 p.m.