fetch_subject_demographic_summary: Gets a overall demographic summary by subject

In benwhicks/retention.helpers: Munging, visualisation and analysis helper functions

Gets a overall demographic summary by subject

Description

Returns a summary of basic key demographics breakdown based on a selection of subjects. Currently the key demographics selected by this function are Low SES, Australian Indigenous, Regional and First in Family

Usage

fetch_subject_demographic_summary(
  subject_string,
  by_session = TRUE,
  sessions = NULL,
  include_withdrawn = FALSE,
  domestic_only = TRUE
)

Arguments

subject_string	a regex expression used to filter the subjects
by_session	if TRUE then returns one row per subject per session
sessions	a numeric vector with the sessions that the data should be based on, greedy if left as NULL
include_withdrawn	if set to FALSE then students that withdraw are removed from the results
domestic_only	if TRUE then only domestic enrolments are used

Value

a data frame, one row per subject (and per session if by session is TRUE)

benwhicks/retention.helpers documentation built on Feb. 6, 2023, 5:02 p.m.