
Fetch student programme records from SELMA
Source:R/student_programmes.R
selma_student_programmes.RdRetrieves a programme-level view of student enrolments, including completion status and programme details.
Usage
selma_student_programmes(
con = NULL,
student_id = NULL,
cache = FALSE,
cache_dir = "selma_cache",
cache_hours = 24,
items_per_page = 100L,
.progress = TRUE
)Arguments
- con
A
selma_connectionobject fromselma_connect(), orNULL(default) to use the stored connection.- student_id
Filter by student ID.
- cache
If
TRUE, use RDS caching (defaultFALSE).- cache_dir
Directory for cache files (default
"selma_cache").- cache_hours
Hours before cache is considered stale (default 24).
- items_per_page
Items per API page (default 100).
- .progress
Show progress messages (default
TRUE).
Value
A tibble of student-programme records with columns including
student_id, enrol_id, prog_id, prog_title, prog_code,
enr_status, and enr_completion_date.
Examples
if (FALSE) { # \dontrun{
selma_connect()
student_progs <- selma_student_programmes()
student_progs <- selma_student_programmes(student_id = "123")
} # }