get_users_in_course: Get users in course

In ICTO-FMG/uvacanvas: Utility Functions for ICTO-FMG for CANVAS API

Description

Gets all user information from a specified course. You can use the argument enrollment_type to set a specific filter to user type or the argument enrollment_state for a specific enrollment state of the user, to save some time.

Gets all user information from a specified course. You can use the argument enrollment_type to set a specific filter to user type or the argument enrollment_state for a specific enrollment state of the user, to save some time.

Usage

get_users_in_course(
  course_id,
  enrollment_type = NULL,
  enrollment_state = NULL,
  include = "enrollments"
)

get_users_in_course(
  course_id,
  enrollment_type = NULL,
  enrollment_state = NULL,
  include = "enrollments"
)

Arguments

course_id	the canvas id of the course (integer)
enrollment_type	the canvas enrollment type to return. Use either "StudentEnrollment", "TeacherEnrollment". Default returns all roles. (character)
enrollment_state	include users with a specific state. Use either "active", "invited", "deleted" or "completed". Default is "active" and "invited" (character)

Value

A dataframe containing information about users in the specified course.

A dataframe containing information about users in the specified course.

Examples

get_users_in_course(6348, enrollment_type = "student", enrollment_state = "active")

get_users_in_course(6348, enrollment_type = "student", enrollment_state = "active")

ICTO-FMG/uvacanvas documentation built on Jan. 24, 2022, 5:16 a.m.