get_course_analytics_data: Function to return course analytics data.

In daranzolin/rcanvas: R Client for Canvas API

Function to return course analytics data.

Description

Returns a data.frame of course analytics data. Note: if an individual's user_id is specified, the function will return a list.

Usage

get_course_analytics_data(course_id, type = "assignments", user_id = NULL)

Arguments

course_id	A valid Canvas course id
type	One of "assignments", "activity", or "student_summaries"
user_id	Optional argument to specify type analytics for individual user id

Value

data frame or list if user_id is specified

Examples

#' get_course_analytics_data(course_id = 20)
#' get_course_analytics_data(course_id = 17, type = "activity")
#' get_course_analytics_data(course_id = 17, type = "student_summaries", user_id = 366)

daranzolin/rcanvas documentation built on May 18, 2024, 2:33 p.m.