Learn R Programming

vvcanvas (version 0.0.8)

get_section_students: Retrieve Students in a Section

Description

This function retrieves a list of students enrolled in a specific section of a course in Canvas LMS.

Usage

get_section_students(canvas, section_id, per_page = 100)

Value

A data frame containing details of students enrolled in the specified section.

Arguments

canvas

A list containing the Canvas API key and base URL, typically obtained through a canvas_authenticate function.

section_id

The ID of the section for which to retrieve students.

per_page

(Optional) The number of student records to retrieve per page of results. Defaults to 100.

Examples

Run this code
if (FALSE) {
canvas <- list(base_url = "https://your_canvas_instance.instructure.com", api_key = "your_api_key")
section_id <- "67890"
students <- get_section_students(canvas, section_id)
print(students)
}

Run the code above in your browser using DataLab