fetch_enrolled_users: Fetch users enrolled in a course

Description Usage Arguments Details Value See Also

Description

Returns the first enrollment record for each user currently enrolled in the specified course.

Usage

1
2
fetch_enrolled_users(course_id, methods = NULL, after = NULL,
  before = NULL, ..., con = get_session_con())

Arguments

course_id

A single integer corresponding to a courseid in the database.

methods

Vector of strings specifying which enrollment methods to include. A NULL value allows all enrollment methods.

after

A single UNIX datetime in any format that can be cast to a lubridate datetime object. Enrollments before this time will be excluded. A NULL value will not apply this filter.

before

A single UNIX datetime in any format that can be cast to a lubridate datetime object. Enrollments on and after this time will be excluded. A NULL value will not apply this filter.

...

Potential future args.

con

A database connection object, using the session connection by default.

Details

This will not return users who were unenrolled (usually by request) from the course.

If a user has multiple enrollments for the same course, the earlier enrollment is returned. An example case of duplicates is LD Fall 2017 where the enrollment engine was used to batch assign groups, resulting in multiple enrollment methods

Value

Tibble of users enrolled in the course and enrollment details.

See Also

fetch_unenrolled_users


TheFridayInstitute/fimoodler documentation built on May 28, 2019, 9:37 a.m.