diff --git a/pkgdown.yml b/pkgdown.yml index 75b4f52..e826c26 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -5,7 +5,7 @@ articles: getting_started: getting_started.html groups_use_case: groups_use_case.html QTI_quiz: QTI_quiz.html -last_built: 2024-08-23T07:38Z +last_built: 2024-09-02T11:38Z urls: reference: https://vusaverse.github.io/vvcanvas/reference article: https://vusaverse.github.io/vvcanvas/articles diff --git a/reference/create_module.html b/reference/create_module.html new file mode 100644 index 0000000..f21ffe0 --- /dev/null +++ b/reference/create_module.html @@ -0,0 +1,94 @@ + +Create a Module in Canvas LMS — create_module • vvcanvas + Skip to contents + + +
+
+
+

Create a Module in Canvas LMS

+ Source: R/create_module.R +
create_module.Rd
+
+ +
+

Creates a new module in a specific course using the Canvas LMS API.

+
+ +
+

Usage

+ 
create_module(canvas, course_id, module_name, position = NULL)
+
+ +
+

Arguments

+ + +
canvas
+

A list containing the 'api_key' and 'base_url' for authentication.

+ + +
course_id
+

The ID of the course in which to create the module.

+ + +
module_name
+

The title of the module.

+ + +
position
+

(Optional) The position of this module in the course

+ +
+
+

Value

+

A confirmation message that the module has been created.

+
+ +
+ + +
+ + + + + + + diff --git a/reference/create_module_item.html b/reference/create_module_item.html new file mode 100644 index 0000000..0357940 --- /dev/null +++ b/reference/create_module_item.html @@ -0,0 +1,119 @@ + +Create a Module Item in Canvas LMS — create_module_item • vvcanvas + Skip to contents + + +
+
+
+

Create a Module Item in Canvas LMS

+ Source: R/create_module_item.R +
create_module_item.Rd
+
+ +
+

Creates a new item in a specific module in a specifc course using the Canvas LMS API.

+
+ +
+

Usage

+ 
create_module_item(
+  canvas,
+  course_id,
+  module_id,
+  item_title,
+  item_type = "Page",
+  position = NULL,
+  page_url = NULL,
+  page_id = NULL
+)
+
+ +
+

Arguments

+ + +
canvas
+

A list containing the 'api_key' and 'base_url' for authentication.

+ + +
course_id
+

The ID of the course in which to create the module item.

+ + +
module_id
+

The ID of the module in which to create the item.

+ + +
item_title
+

The title of the new item within the module.

+ + +
item_type
+

The type of item. Defaults to "Page".

+ + +
position
+

(Optional) The position of the item within the module. Defaults to 1.

+ + +
page_url
+

(Optional) The url of the page.

+ + +
page_id
+

(Optional) The id of the page.

+ +
+
+

Value

+

A confirmation message that the page has been created.

+
+ +
+ + +
+ + + + + + + diff --git a/reference/index.html b/reference/index.html index 3953502..81762bc 100644 --- a/reference/index.html +++ b/reference/index.html @@ -498,6 +498,12 @@

Modules
Retrieves the modules within a course.
+
+ + create_module() + +
+
Create a Module in Canvas LMS

Module Items

@@ -515,6 +521,12 @@

Module Itemscreate_module_item() + + +
Create a Module Item in Canvas LMS

Pages

diff --git a/search.json b/search.json index 5ae8c7e..53480b0 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://vusaverse.github.io/vvcanvas/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2023 vvcanvas authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"vignette demonstrates upload QTI file Canvas LMS, retrieve list quizzes upload, update quiz parameters using R. process involves using get_course_quizzes update_quiz functions.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"step-1-authenticate-with-canvas","dir":"Articles","previous_headings":"","what":"Step 1: Authenticate with Canvas","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"First, authenticate Canvas creating canvas object containing API key base URL:","code":"canvas <- vvcanvas::canvas_authenticate()"},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"step-2-retrieve-the-list-of-quizzes","dir":"Articles","previous_headings":"","what":"Step 2: Retrieve the List of Quizzes","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"Retrieve list quizzes course uploading QTI file:","code":"course_id <- \"12345\" # Replace with your actual course ID quizzes_before <- get_course_quizzes(canvas, course_id)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"step-3-upload-the-qti-file","dir":"Articles","previous_headings":"","what":"Step 3: Upload the QTI File","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"Use upload_qti_file_with_migration function upload QTI file. function defined handle QTI file upload process:","code":"# Define the function if not already defined # Upload the QTI file file_path <- \"path/to/your/qti_file.zip\" # Replace with your actual file path upload_qti_file_with_migration(canvas, course_id = course_id, file_path = \"qti_file.zip\", pre_attachment_size = \"12345\", pre_attachment_name = \"test\")"},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"step-4-retrieve-quizzes-after-upload","dir":"Articles","previous_headings":"","what":"Step 4: Retrieve Quizzes After Upload","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"Retrieve list quizzes QTI file upload:","code":"quizzes_after <- get_course_quizzes(canvas, course_id) print(quizzes_after)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"step-5-identify-the-new-quiz","dir":"Articles","previous_headings":"","what":"Step 5: Identify the New Quiz","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"Compare lists quizzes upload identify newly created quiz:","code":"new_quiz <- setdiff(quizzes_after, quizzes_before) print(new_quiz)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"step-6-update-quiz-parameters","dir":"Articles","previous_headings":"","what":"Step 6: Update Quiz Parameters","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"Use update_quiz function modify parameters newly created quiz:","code":"quiz_id <- new_quiz$id # Assuming there's only one new quiz quiz_params <- list( title = \"Updated Quiz Title\", description = \"Updated description of the quiz.\", due_at = \"2013-01-23T23:59:00-07:00\" ) updated_quiz <- update_quiz(canvas, course_id, quiz_id, quiz_params) print(updated_quiz)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"conclusion","dir":"Articles","previous_headings":"","what":"Conclusion","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"vignette demonstrated upload QTI file Canvas LMS, identify newly created quiz, update parameters. can extend process modify quiz attributes needed.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/articles/getting_started.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Getting Started","text":"vvcanvas package designed interact Canvas Learning Management System (LMS) API. vignette provides basic guide authenticate, retrieve course information, fetch specific details using package.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/articles/getting_started.html","id":"installation","dir":"Articles","previous_headings":"","what":"Installation","title":"Getting Started","text":"install vvcanvas package, can use following command:","code":"install_github(\"vusaverse/vvcanvas\") library(vvcanvas)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/getting_started.html","id":"authentication","dir":"Articles","previous_headings":"","what":"Authentication","title":"Getting Started","text":"start using package, need authenticate Canvas LMS API using API key base URL. ’s example authenticate:","code":"# Replace the placeholders with your API key and base URL api_key <- \"YOUR_API_KEY\" base_url <- \"https://your_canvas_domain.com/\" # Authenticate with the Canvas LMS API canvas <- canvas_authenticate(api_key, base_url) ## Alternatively, you can set system variables # Set the API key and base URL as environment variables Sys.setenv(CANVAS_API_KEY = \"YOUR_API_KEY\") Sys.setenv(CANVAS_BASE_URL = \"https://your_canvas_domain.com/\") # Authenticate with the Canvas LMS API canvas <- canvas_authenticate()"},{"path":"https://vusaverse.github.io/vvcanvas/articles/getting_started.html","id":"retrieving-course-information","dir":"Articles","previous_headings":"","what":"Retrieving Course Information","title":"Getting Started","text":"authenticated, can retrieve course information using get_courses function. ’s example:","code":"# Fetch the dataframe of courses courses <- get_courses(canvas) head(courses)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/getting_started.html","id":"fetching-specific-details","dir":"Articles","previous_headings":"","what":"Fetching Specific Details","title":"Getting Started","text":"vvcanvas package provides various functions fetch specific details. example, retrieve assignments within course, can use get_assignments function:","code":"# Replace the placeholder with the desired course ID course_id <- 12345 # Fetch the assignments for the course assignments <- get_assignments(canvas, course_id) head(assignments)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/groups_use_case.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Working with groups","text":"vignette demonstrates retrieve group memberships course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/articles/groups_use_case.html","id":"step-1-list-courses","dir":"Articles","previous_headings":"","what":"Step 1: List courses","title":"Working with groups","text":"","code":"library(vvcanvas) # Specify the Canvas API authentication details canvas <- list( api_key = \"YOUR_API_KEY\", base_url = \"https://your_canvas_instance/\" ) # Retrieve all courses courses <- get_courses(canvas) # Select a course (replace the index with the desired course) course_id <- course$id[1] ## the first course in courses"},{"path":"https://vusaverse.github.io/vvcanvas/articles/groups_use_case.html","id":"step-2-retrieve-all-groups-in-the-course","dir":"Articles","previous_headings":"","what":"Step 2: Retrieve all groups in the course","title":"Working with groups","text":"","code":"# Retrieve all groups in the selected course groups <- get_course_groups(canvas, course_id) # Extract the group IDs group_ids <- groups$id"},{"path":"https://vusaverse.github.io/vvcanvas/articles/groups_use_case.html","id":"step-3-retrieve-group-memberships","dir":"Articles","previous_headings":"","what":"Step 3: Retrieve group memberships","title":"Working with groups","text":"","code":"# Retrieve group memberships using purrr memberships <- purrr::map_df(group_ids, ~{ group_id <- .x # Retrieve the group's memberships group_memberships <- get_group_users(canvas, group_id) # Extract user names from memberships user_names <- group_memberships$name # Create a data frame with group memberships group_df <- data.frame(group_id = rep(group_id, length(user_names)), user_name = user_names, stringsAsFactors = FALSE) return(group_df) })"},{"path":"https://vusaverse.github.io/vvcanvas/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Tomer Iwan. Author, maintainer, copyright holder.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Iwan T (2024). vvcanvas: 'Canvas' LMS API Integration. R package version 0.0.4, https://vusaverse.github.io/vvcanvas/, https://github.com/vusaverse/vvcanvas.","code":"@Manual{, title = {vvcanvas: 'Canvas' LMS API Integration}, author = {Tomer Iwan}, year = {2024}, note = {R package version 0.0.4, https://vusaverse.github.io/vvcanvas/}, url = {https://github.com/vusaverse/vvcanvas}, }"},{"path":"https://vusaverse.github.io/vvcanvas/index.html","id":"vvcanvas-","dir":"","previous_headings":"","what":"Canvas LMS API Integration","title":"Canvas LMS API Integration","text":"vvcanvas package R library provides convenient interface interact Canvas Learning Management System (LMS) API. allows users authenticate, retrieve course information, fetch specific details, perform various operations within Canvas LMS.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Canvas LMS API Integration","text":"can install vvcanvas package GitHub using following command: also possible install CRAN:","code":"devtools::install_github(\"vusaverse/vvcanvas\") install.packages(\"vvcanvas\")"},{"path":"https://vusaverse.github.io/vvcanvas/index.html","id":"features","dir":"","previous_headings":"","what":"Features","title":"Canvas LMS API Integration","text":"see functions available section based CANVAS LMS API structure, please refer reference page vvcanvas package. reference page provides comprehensive list functions available package, organized category. Additionally, package includes vignettes provide detailed information use functions package.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/index.html","id":"getting-started","dir":"","previous_headings":"","what":"Getting Started","title":"Canvas LMS API Integration","text":"begin using vvcanvas package, need authenticate Canvas LMS API obtaining API key base URL. Follow steps get started: Acquire API key Canvas LMS instance. may need consult Canvas administrator refer Canvas API documentation instructions obtaining API key. API key, load vvcanvas library use canvas_authenticate function authenticate Canvas LMS API. Provide API key base URL Canvas instance parameters. ’s example: authentication step completed, can now utilize various functions provided vvcanvas package interact Canvas LMS. order retrieve dataframe courses can use following function:","code":"library(vvcanvas) # Replace the placeholders with your API key and base URL api_key <- \"YOUR_API_KEY\" base_url <- \"https://your_canvas_domain.com/\" # Authenticate with the Canvas LMS API canvas <- canvas_authenticate(api_key, base_url) ## Alternatively, you can set system variables # Set the API key and base URL as environment variables Sys.setenv(CANVAS_API_KEY = \"YOUR_API_KEY\") Sys.setenv(CANVAS_BASE_URL = \"https://your_canvas_domain.com/\") # Authenticate with the Canvas LMS API canvas <- canvas_authenticate() # Pass the canvas object to the get_courses function courses <- get_courses(canvas)"},{"path":"https://vusaverse.github.io/vvcanvas/index.html","id":"canvas-analytics-project","dir":"","previous_headings":"","what":"Canvas Analytics Project","title":"Canvas LMS API Integration","text":"canvas-analytics project provides data pipeline extracting, aggregating, analyzing data Canvas Learning Management System (LMS) using vvcanvas package. aims facilitate data retrieval analysis student, course, program levels, enabling data-driven insights decision-making education learning analytics. Key features include: Data extraction Canvas LMS API Data aggregation different levels (student, course, program) Data visualization reporting Reproducible extensible analysis workflow","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_api_key.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the Canvas API key from the environment variable — canvas_api_key","title":"Get the Canvas API key from the environment variable — canvas_api_key","text":"Get Canvas API key environment variable","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_api_key.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the Canvas API key from the environment variable — canvas_api_key","text":"","code":"canvas_api_key()"},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_api_key.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the Canvas API key from the environment variable — canvas_api_key","text":"Canvas API key stored CANVAS_API_KEY environment variable.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_authenticate.html","id":null,"dir":"Reference","previous_headings":"","what":"Authenticate with Canvas LMS API — canvas_authenticate","title":"Authenticate with Canvas LMS API — canvas_authenticate","text":"function handles authentication Canvas LMS API. uses provided API key base URL, falls back CANVAS_API_KEY CANVAS_BASE_URL environment variables none provided.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_authenticate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Authenticate with Canvas LMS API — canvas_authenticate","text":"","code":"canvas_authenticate(api_key = canvas_api_key(), base_url = canvas_base_url())"},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_authenticate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Authenticate with Canvas LMS API — canvas_authenticate","text":"api_key API key authenticating Canvas LMS API. Defaults CANVAS_API_KEY environment variable. base_url base URL Canvas instance. Defaults CANVAS_BASE_URL environment variable.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_authenticate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Authenticate with Canvas LMS API — canvas_authenticate","text":"list containing authenticated 'api_key' 'base_url'.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_authenticate.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Authenticate with Canvas LMS API — canvas_authenticate","text":"function verifies authentication making test request /api/v1/users/self endpoint Canvas instance. response status code 200, throws error message indicating authentication failed.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_authenticate.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Authenticate with Canvas LMS API — canvas_authenticate","text":"","code":"if (FALSE) { # \\dontrun{ # Authenticate with the Canvas LMS API api_key <- \"your_api_key\" base_url <- \"https://canvas.example.com\" canvas <- canvas_authenticate(api_key, base_url) } # }"},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_base_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the Canvas base URL from the environment variable — canvas_base_url","title":"Get the Canvas base URL from the environment variable — canvas_base_url","text":"Get Canvas base URL environment variable","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_base_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the Canvas base URL from the environment variable — canvas_base_url","text":"","code":"canvas_base_url()"},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_base_url.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the Canvas base URL from the environment variable — canvas_base_url","text":"Canvas base URL stored CANVAS_BASE_URL environment variable.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_assignment_group.html","id":null,"dir":"Reference","previous_headings":"","what":"Create an Assignment Group in Canvas LMS — create_assignment_group","title":"Create an Assignment Group in Canvas LMS — create_assignment_group","text":"Creates new assignment group specific course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_assignment_group.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create an Assignment Group in Canvas LMS — create_assignment_group","text":"","code":"create_assignment_group(canvas, course_id, group_name, group_position = NULL)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_assignment_group.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create an Assignment Group in Canvas LMS — create_assignment_group","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create assignment group. group_name name assignment group. group_position position assignment group course (optional).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_assignment_group.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create an Assignment Group in Canvas LMS — create_assignment_group","text":"confirmation message assignment group created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_datalake.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a data lake for a course. — create_course_datalake","title":"Create a data lake for a course. — create_course_datalake","text":"function retrieves data various endpoints specific course Canvas LMS API stores data JSON files specified storage location.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_datalake.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a data lake for a course. — create_course_datalake","text":"","code":"create_course_datalake(canvas, course_id, storage_location)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_datalake.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a data lake for a course. — create_course_datalake","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course create data lake. storage_location path storage location data files saved.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_datalake.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a data lake for a course. — create_course_datalake","text":"NULL.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_datalake.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Create a data lake for a course. — create_course_datalake","text":"function retrieves data various endpoints. Access certain endpoints may require specific roles.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_section.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Course Section in Canvas LMS — create_course_section","title":"Create a Course Section in Canvas LMS — create_course_section","text":"Creates new course section specific course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_section.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Course Section in Canvas LMS — create_course_section","text":"","code":"create_course_section( canvas, course_id, section_name, section_start_date = NULL, section_end_date = NULL )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_section.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Course Section in Canvas LMS — create_course_section","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create section. section_name name section. section_start_date (Optional) start date section. section_end_date (Optional) end date section.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_section.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Course Section in Canvas LMS — create_course_section","text":"confirmation message section created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_folder.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Folder in Canvas LMS — create_folder","title":"Create a Folder in Canvas LMS — create_folder","text":"Creates new folder specific course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_folder.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Folder in Canvas LMS — create_folder","text":"","code":"create_folder(canvas, course_id, folder_name, parent_folder_id = NULL)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_folder.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Folder in Canvas LMS — create_folder","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create folder. folder_name name folder. parent_folder_id (Optional) ID parent folder create folder.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_folder.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Folder in Canvas LMS — create_folder","text":"confirmation message folder created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_group_category.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Group Category in Canvas LMS — create_group_category","title":"Create a Group Category in Canvas LMS — create_group_category","text":"Creates new group category specific course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_group_category.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Group Category in Canvas LMS — create_group_category","text":"","code":"create_group_category( canvas, course_id, category_name, allow_self_signup = FALSE )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_group_category.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Group Category in Canvas LMS — create_group_category","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create group category. category_name name group category. allow_self_signup (Optional) Whether allow self-signup groups category. Defaults FALSE.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_group_category.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Group Category in Canvas LMS — create_group_category","text":"confirmation message group category created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_page.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Page in Canvas LMS — create_page","title":"Create a Page in Canvas LMS — create_page","text":"Creates new page specific course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_page.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Page in Canvas LMS — create_page","text":"","code":"create_page(canvas, course_id, page_title, page_body, published = FALSE)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_page.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Page in Canvas LMS — create_page","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create page. page_title title page. page_body body/content page. published (Optional) Whether page published. Defaults FALSE.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_page.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Page in Canvas LMS — create_page","text":"confirmation message page created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/delete_course_section.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a Course Section in Canvas LMS — delete_course_section","title":"Delete a Course Section in Canvas LMS — delete_course_section","text":"Deletes existing course section using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/delete_course_section.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a Course Section in Canvas LMS — delete_course_section","text":"","code":"delete_course_section(canvas, section_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/delete_course_section.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a Course Section in Canvas LMS — delete_course_section","text":"canvas list containing 'api_key' 'base_url' authentication. section_id ID section delete.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/delete_course_section.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a Course Section in Canvas LMS — delete_course_section","text":"confirmation message section deleted.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/download_course_file.html","id":null,"dir":"Reference","previous_headings":"","what":"Downloads a file from a given URL. — download_course_file","title":"Downloads a file from a given URL. — download_course_file","text":"function downloads file specified URL saves locally.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/download_course_file.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Downloads a file from a given URL. — download_course_file","text":"","code":"download_course_file(canvas, file_url, download_path)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/download_course_file.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Downloads a file from a given URL. — download_course_file","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. file_url URL file download. download_path path file downloaded.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/download_course_file.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Downloads a file from a given URL. — download_course_file","text":"path downloaded file.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/download_course_file.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Downloads a file from a given URL. — download_course_file","text":"","code":"if (FALSE) { # \\dontrun{ # Download a file from a given URL canvas <- canvas_authenticate(api_key, base_url) file_url <- \"https://example.com/file.pdf\" download_path <- \"path/to/save/file.pdf\" file_path <- download_course_file(canvas, file_url, download_path) } # }"},{"path":"https://vusaverse.github.io/vvcanvas/reference/edit_section.html","id":null,"dir":"Reference","previous_headings":"","what":"Edit a Course Section in Canvas LMS — edit_section","title":"Edit a Course Section in Canvas LMS — edit_section","text":"Modifies existing course section using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/edit_section.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Edit a Course Section in Canvas LMS — edit_section","text":"","code":"edit_section( canvas, section_id, section_name = NULL, sis_section_id = NULL, integration_id = NULL, section_start_date = NULL, section_end_date = NULL, restrict_enrollments_to_section_dates = NULL, override_sis_stickiness = NULL )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/edit_section.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Edit a Course Section in Canvas LMS — edit_section","text":"canvas list containing 'api_key' 'base_url' authentication. section_id ID section edit. section_name new name section (optional). sis_section_id new SIS ID section (optional). integration_id new integration ID section (optional). section_start_date new start date section (optional). section_end_date new end date section (optional). restrict_enrollments_to_section_dates Whether restrict user enrollments start end dates section (optional). override_sis_stickiness Whether override SIS stickiness (optional).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/edit_section.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Edit a Course Section in Canvas LMS — edit_section","text":"confirmation message section edited.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_accounts.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a list of accounts from the Canvas LMS API — get_accounts","title":"Get a list of accounts from the Canvas LMS API — get_accounts","text":"Retrieves paginated list accounts current user can view manage.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_accounts.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a list of accounts from the Canvas LMS API — get_accounts","text":"","code":"get_accounts(canvas, include = NULL, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_accounts.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a list of accounts from the Canvas LMS API — get_accounts","text":"canvas list containing 'api_key' 'base_url' authentication. include vector additional information include. Default NULL. per_page Number accounts retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_accounts.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a list of accounts from the Canvas LMS API — get_accounts","text":"list accounts retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_all_courses.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves a paginated list of all courses visible in the public index. — get_all_courses","title":"Retrieves a paginated list of all courses visible in the public index. — get_all_courses","text":"function retrieves paginated list courses visible public index using Canvas LMS API. NOTE function might take finish.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_all_courses.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves a paginated list of all courses visible in the public index. — get_all_courses","text":"","code":"get_all_courses(canvas, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_all_courses.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves a paginated list of all courses visible in the public index. — get_all_courses","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. per_page (Optional) number courses retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_all_courses.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves a paginated list of all courses visible in the public index. — get_all_courses","text":"data frame courses visible public index.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Get course-level assignment data from the Canvas LMS API — get_assignment_data","title":"Get course-level assignment data from the Canvas LMS API — get_assignment_data","text":"Retrieves course-level assignment data specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get course-level assignment data from the Canvas LMS API — get_assignment_data","text":"","code":"get_assignment_data(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get course-level assignment data from the Canvas LMS API — get_assignment_data","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve assignment data. per_page Number assignment data retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get course-level assignment data from the Canvas LMS API — get_assignment_data","text":"list assignment data retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_details.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Assignment Details from Canvas LMS API — get_assignment_details","title":"Get Assignment Details from Canvas LMS API — get_assignment_details","text":"Retrieves detailed information specific assignment Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_details.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Assignment Details from Canvas LMS API — get_assignment_details","text":"","code":"get_assignment_details(canvas, course_id, assignment_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_details.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Assignment Details from Canvas LMS API — get_assignment_details","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course assignment resides. assignment_id ID assignment retrieve details.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_details.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Assignment Details from Canvas LMS API — get_assignment_details","text":"dataframe containing detailed information assignment.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_groups.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the assignment groups within a course. — get_assignment_groups","title":"Retrieves the assignment groups within a course. — get_assignment_groups","text":"function retrieves assignment groups within specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_groups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the assignment groups within a course. — get_assignment_groups","text":"","code":"get_assignment_groups(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_groups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the assignment groups within a course. — get_assignment_groups","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch assignment groups. per_page number entries show per page.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_groups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the assignment groups within a course. — get_assignment_groups","text":"list assignment groups within specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_submissions.html","id":null,"dir":"Reference","previous_headings":"","what":"Lists assignment submissions for a course. — get_assignment_submissions","title":"Lists assignment submissions for a course. — get_assignment_submissions","text":"function retrieves list assignment submissions specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_submissions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lists assignment submissions for a course. — get_assignment_submissions","text":"","code":"get_assignment_submissions( canvas, course_id, assignment_id = NULL, per_page = 100 )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_submissions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lists assignment submissions for a course. — get_assignment_submissions","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course list assignment submissions. assignment_id (Optional) ID specific assignment list submissions. per_page (Optional) number submissions retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_submissions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lists assignment submissions for a course. — get_assignment_submissions","text":"data frame assignment submissions specified course assignment.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignments.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Assignments from Canvas LMS API — get_assignments","title":"Get Assignments from Canvas LMS API — get_assignments","text":"Fetches list assignments within specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignments.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Assignments from Canvas LMS API — get_assignments","text":"","code":"get_assignments(canvas, course_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignments.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Assignments from Canvas LMS API — get_assignments","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve assignments.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignments.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Assignments from Canvas LMS API — get_assignments","text":"list assignments retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_calendar_events.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Calendar Events from Canvas LMS API — get_calendar_events","title":"Get Calendar Events from Canvas LMS API — get_calendar_events","text":"Retrieve paginated list calendar events assignments current user.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_calendar_events.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Calendar Events from Canvas LMS API — get_calendar_events","text":"","code":"get_calendar_events( canvas, type = \"event\", start_date = NULL, end_date = NULL, undated = FALSE, all_events = FALSE, context_codes = NULL, excludes = NULL, includes = NULL, important_dates = FALSE, blackout_date = FALSE )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_calendar_events.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Calendar Events from Canvas LMS API — get_calendar_events","text":"canvas list containing 'api_key' 'base_url' authentication. type type events retrieve. Default \"event\". Allowed values: event, assignment. start_date return events since start_date (inclusive). Defaults today. end_date return events end_date (inclusive). Defaults start_date. undated Defaults false (dated events ). true, return undated events ignore start_date end_date. all_events Defaults false (uses start_date, end_date, undated criteria). true, events returned, ignoring start_date, end_date, undated criteria. context_codes List context codes courses, groups, users, accounts whose events want see. specified, defaults current user (.e personal calendar, course/group events). excludes Array attributes exclude. Possible values “description”, “child_events” “assignment”. includes Array optional attributes include. Possible values “web_conference” calendar_series flag , “series_natural_language”. important_dates Defaults false. true, events important dates set true returned. blackout_date Defaults false. true, events blackout date set true returned.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_calendar_events.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Calendar Events from Canvas LMS API — get_calendar_events","text":"data frame calendar events retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_announcements.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves course announcements. — get_course_announcements","title":"Retrieves course announcements. — get_course_announcements","text":"function retrieves list announcements specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_announcements.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves course announcements. — get_course_announcements","text":"","code":"get_course_announcements(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_announcements.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves course announcements. — get_course_announcements","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course retrieve announcements. per_page (Optional) number announcements retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_announcements.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves course announcements. — get_course_announcements","text":"data frame course announcements.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_details.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Course Details from Canvas LMS API — get_course_details","title":"Get Course Details from Canvas LMS API — get_course_details","text":"Retrieves detailed information specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_details.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Course Details from Canvas LMS API — get_course_details","text":"","code":"get_course_details(canvas, course_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_details.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Course Details from Canvas LMS API — get_course_details","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve details.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_details.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Course Details from Canvas LMS API — get_course_details","text":"dataframe containing detailed information course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_enrollments.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the course enrollments for a course. — get_course_enrollments","title":"Retrieves the course enrollments for a course. — get_course_enrollments","text":"function retrieves enrollments students roles specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_enrollments.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the course enrollments for a course. — get_course_enrollments","text":"","code":"get_course_enrollments(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_enrollments.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the course enrollments for a course. — get_course_enrollments","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch enrollments. per_page (Optional) number enrollments retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_enrollments.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the course enrollments for a course. — get_course_enrollments","text":"data frame course enrollments specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_files.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves a list of files within a course. — get_course_files","title":"Retrieves a list of files within a course. — get_course_files","text":"function retrieves list files within specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_files.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves a list of files within a course. — get_course_files","text":"","code":"get_course_files(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_files.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves a list of files within a course. — get_course_files","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch files. per_page (Optional) number files retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_files.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves a list of files within a course. — get_course_files","text":"data frame files within specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_folders.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves course folders. — get_course_folders","title":"Retrieves course folders. — get_course_folders","text":"function retrieves list folders specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_folders.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves course folders. — get_course_folders","text":"","code":"get_course_folders(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_folders.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves course folders. — get_course_folders","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course retrieve folders. per_page Number courses retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_folders.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves course folders. — get_course_folders","text":"data frame course folders.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_groups.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the list of groups in a course. — get_course_groups","title":"Retrieves the list of groups in a course. — get_course_groups","text":"function retrieves list groups specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_groups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the list of groups in a course. — get_course_groups","text":"","code":"get_course_groups(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_groups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the list of groups in a course. — get_course_groups","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course fetch groups. per_page (Optional) number groups retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_groups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the list of groups in a course. — get_course_groups","text":"data frame groups specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_media_objects.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the media objects in a course. — get_course_media_objects","title":"Retrieves the media objects in a course. — get_course_media_objects","text":"function retrieves media objects associated specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_media_objects.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the media objects in a course. — get_course_media_objects","text":"","code":"get_course_media_objects(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_media_objects.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the media objects in a course. — get_course_media_objects","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch media objects. per_page number entries show per page.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_media_objects.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the media objects in a course. — get_course_media_objects","text":"data frame containing media objects specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_pages.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the pages within a course. — get_course_pages","title":"Retrieves the pages within a course. — get_course_pages","text":"function retrieves pages within specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_pages.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the pages within a course. — get_course_pages","text":"","code":"get_course_pages(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_pages.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the pages within a course. — get_course_pages","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch pages. per_page (Optional) number pages retrieve per page results (default 50).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_pages.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the pages within a course. — get_course_pages","text":"list pages within specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_participation.html","id":null,"dir":"Reference","previous_headings":"","what":"Get course-level participation data from Canvas LMS API — get_course_participation","title":"Get course-level participation data from Canvas LMS API — get_course_participation","text":"Fetches participation data specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_participation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get course-level participation data from Canvas LMS API — get_course_participation","text":"","code":"get_course_participation(canvas, course_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_participation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get course-level participation data from Canvas LMS API — get_course_participation","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve participation data.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_participation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get course-level participation data from Canvas LMS API — get_course_participation","text":"participation data specified course retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_quizzes.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves course quizzes. — get_course_quizzes","title":"Retrieves course quizzes. — get_course_quizzes","text":"function retrieves list quizzes specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_quizzes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves course quizzes. — get_course_quizzes","text":"","code":"get_course_quizzes(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_quizzes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves course quizzes. — get_course_quizzes","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course retrieve quizzes. per_page (Optional) number quizzes retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_quizzes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves course quizzes. — get_course_quizzes","text":"data frame course quizzes.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_sections.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves course sections. — get_course_sections","title":"Retrieves course sections. — get_course_sections","text":"function retrieves list sections specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_sections.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves course sections. — get_course_sections","text":"","code":"get_course_sections(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_sections.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves course sections. — get_course_sections","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course retrieve sections. per_page (Optional) number sections retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_sections.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves course sections. — get_course_sections","text":"data frame course sections.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_students.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the list of students in a course. — get_course_students","title":"Retrieves the list of students in a course. — get_course_students","text":"function retrieves list students enrolled specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_students.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the list of students in a course. — get_course_students","text":"","code":"get_course_students(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_students.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the list of students in a course. — get_course_students","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch students. per_page (Optional) number students retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_students.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the list of students in a course. — get_course_students","text":"data frame students enrolled specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_users.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the users in a course. — get_course_users","title":"Retrieves the users in a course. — get_course_users","text":"function retrieves users enrolled specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_users.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the users in a course. — get_course_users","text":"","code":"get_course_users( canvas, course_id, per_page = 100, include = c(\"enrollments\", \"locked\", \"avatar_url\", \"test_student\", \"bio\", \"custom_links\", \"current_grading_period_scores\", \"uuid\") )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_users.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the users in a course. — get_course_users","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch users. per_page number entries show per page. include Optional parameters include response. Possible values: \"enrollments\", \"locked\", \"avatar_url\", \"test_student\", \"bio\", \"custom_links\", \"current_grading_period_scores\", \"uuid\".","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_users.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the users in a course. — get_course_users","text":"data frame containing users specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_courses.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Courses from Canvas LMS API — get_courses","title":"Get Courses from Canvas LMS API — get_courses","text":"Retrieves list courses Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_courses.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Courses from Canvas LMS API — get_courses","text":"","code":"get_courses(canvas, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_courses.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Courses from Canvas LMS API — get_courses","text":"canvas list containing 'api_key' 'base_url' authentication. per_page Number courses retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_courses.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Courses from Canvas LMS API — get_courses","text":"list courses retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_grade_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Get department-level grade data from the Canvas LMS API — get_department_grade_data","title":"Get department-level grade data from the Canvas LMS API — get_department_grade_data","text":"Retrieves department-level grade data specific account term Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_grade_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get department-level grade data from the Canvas LMS API — get_department_grade_data","text":"","code":"get_department_grade_data( canvas, account_id, type = \"current\", term_id = NULL, per_page = 100 )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_grade_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get department-level grade data from the Canvas LMS API — get_department_grade_data","text":"canvas list containing 'api_key' 'base_url' authentication. account_id ID account retrieve grade data. type type courses include data. Can 'current', 'completed', 'term'. term_id ID term retrieve grade data. used type 'terms/'. per_page Number grade data retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_grade_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get department-level grade data from the Canvas LMS API — get_department_grade_data","text":"data frame grade data retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_participation_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Get department-level participation data from the Canvas LMS API — get_department_participation_data","title":"Get department-level participation data from the Canvas LMS API — get_department_participation_data","text":"Retrieves department-level participation data specific account term Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_participation_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get department-level participation data from the Canvas LMS API — get_department_participation_data","text":"","code":"get_department_participation_data( canvas, account_id, type = \"current\", term_id = NULL, per_page = 100 )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_participation_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get department-level participation data from the Canvas LMS API — get_department_participation_data","text":"canvas list containing 'api_key' 'base_url' authentication. account_id ID account retrieve participation data. type type courses include data. Can 'current', 'completed', 'term'. term_id ID term retrieve participation data. used type 'terms/'. per_page Number participation data retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_participation_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get department-level participation data from the Canvas LMS API — get_department_participation_data","text":"data frame participation data retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics.html","id":null,"dir":"Reference","previous_headings":"","what":"Get department-level statistics from the Canvas LMS API — get_department_statistics","title":"Get department-level statistics from the Canvas LMS API — get_department_statistics","text":"Retrieves department-level statistics specific account term Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get department-level statistics from the Canvas LMS API — get_department_statistics","text":"","code":"get_department_statistics(canvas, account_id, type = \"current\", term_id = NULL)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get department-level statistics from the Canvas LMS API — get_department_statistics","text":"canvas list containing 'api_key' 'base_url' authentication. account_id ID account retrieve statistics. type type courses include data. Can 'current', 'completed', 'term'. term_id ID term retrieve statistics. used type 'terms/'.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get department-level statistics from the Canvas LMS API — get_department_statistics","text":"list department-level statistics retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics_by_subaccount.html","id":null,"dir":"Reference","previous_headings":"","what":"Get department-level statistics by subaccount from the Canvas LMS API — get_department_statistics_by_subaccount","title":"Get department-level statistics by subaccount from the Canvas LMS API — get_department_statistics_by_subaccount","text":"Retrieves department-level statistics specific account term Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics_by_subaccount.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get department-level statistics by subaccount from the Canvas LMS API — get_department_statistics_by_subaccount","text":"","code":"get_department_statistics_by_subaccount( canvas, account_id, type = \"current\", term_id = NULL )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics_by_subaccount.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get department-level statistics by subaccount from the Canvas LMS API — get_department_statistics_by_subaccount","text":"canvas list containing 'api_key' 'base_url' authentication. account_id ID account retrieve statistics. type type courses include data. Can 'current', 'completed', 'term'. term_id ID term retrieve statistics. used type 'terms/'.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics_by_subaccount.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get department-level statistics by subaccount from the Canvas LMS API — get_department_statistics_by_subaccount","text":"list department-level statistics retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_discussions.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the discussion topics within a course. — get_discussions","title":"Retrieves the discussion topics within a course. — get_discussions","text":"function retrieves discussion topics within specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_discussions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the discussion topics within a course. — get_discussions","text":"","code":"get_discussions(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_discussions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the discussion topics within a course. — get_discussions","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch discussion topics. per_page number entries show","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_discussions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the discussion topics within a course. — get_discussions","text":"list discussion topics within specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_favorite_courses.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Favorite Courses in Canvas LMS — get_favorite_courses","title":"Get Favorite Courses in Canvas LMS — get_favorite_courses","text":"Retrieves data favorite courses authenticated user using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_favorite_courses.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Favorite Courses in Canvas LMS — get_favorite_courses","text":"","code":"get_favorite_courses(canvas, exclude_blueprint_courses = NULL)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_favorite_courses.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Favorite Courses in Canvas LMS — get_favorite_courses","text":"canvas list containing 'api_key' 'base_url' authentication. exclude_blueprint_courses set, return courses configured blueprint courses (optional).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_favorite_courses.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Favorite Courses in Canvas LMS — get_favorite_courses","text":"dataframe favorite courses.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_categories.html","id":null,"dir":"Reference","previous_headings":"","what":"Get group categories for a context — get_group_categories","title":"Get group categories for a context — get_group_categories","text":"function retrieves group categories specific context (e.g., course) Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_categories.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get group categories for a context — get_group_categories","text":"","code":"get_group_categories(canvas, course_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_categories.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get group categories for a context — get_group_categories","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve group categories.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_categories.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get group categories for a context — get_group_categories","text":"data frame group categories specified context.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Get information about a single group — get_group_info","title":"Get information about a single group — get_group_info","text":"function retrieves information specific group Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get information about a single group — get_group_info","text":"","code":"get_group_info(canvas, group_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get information about a single group — get_group_info","text":"canvas list containing 'api_key' 'base_url' authentication. group_id ID group retrieve information.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get information about a single group — get_group_info","text":"list containing information specified group.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_memberships.html","id":null,"dir":"Reference","previous_headings":"","what":"Get group memberships — get_group_memberships","title":"Get group memberships — get_group_memberships","text":"function retrieves memberships specific group Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_memberships.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get group memberships — get_group_memberships","text":"","code":"get_group_memberships(canvas, group_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_memberships.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get group memberships — get_group_memberships","text":"canvas list containing 'api_key' 'base_url' authentication. group_id ID group retrieve memberships.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_memberships.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get group memberships — get_group_memberships","text":"data frame memberships specified group.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_users.html","id":null,"dir":"Reference","previous_headings":"","what":"Get users in a group — get_group_users","title":"Get users in a group — get_group_users","text":"function retrieves users specific group Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_users.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get users in a group — get_group_users","text":"","code":"get_group_users(canvas, group_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_users.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get users in a group — get_group_users","text":"canvas list containing 'api_key' 'base_url' authentication. group_id ID group retrieve users.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_users.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get users in a group — get_group_users","text":"data frame users specified group.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_module_items.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the items within a specific module. — get_module_items","title":"Retrieves the items within a specific module. — get_module_items","text":"function retrieves items within specific module course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_module_items.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the items within a specific module. — get_module_items","text":"","code":"get_module_items(canvas, course_id, module_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_module_items.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the items within a specific module. — get_module_items","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course containing module. module_id ID module fetch items.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_module_items.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the items within a specific module. — get_module_items","text":"list items within specified module.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_modules.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the modules within a course. — get_modules","title":"Retrieves the modules within a course. — get_modules","text":"function retrieves modules within specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_modules.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the modules within a course. — get_modules","text":"","code":"get_modules(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_modules.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the modules within a course. — get_modules","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch modules. per_page number entries show","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_modules.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the modules within a course. — get_modules","text":"list modules within specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_page_content.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the content body of a specified page. — get_page_content","title":"Retrieves the content body of a specified page. — get_page_content","text":"function retrieves content body specified page within course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_page_content.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the content body of a specified page. — get_page_content","text":"","code":"get_page_content(canvas, course_id, page_id, return_as_plain_text = TRUE)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_page_content.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the content body of a specified page. — get_page_content","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course page belongs. page_id ID page fetch content body. return_as_plain_text logical value indicating whether return content plain text (default TRUE).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_page_content.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the content body of a specified page. — get_page_content","text":"content body specified page, either plain text raw HTML.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_roles.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Roles for a Canvas Account — get_roles","title":"Retrieve Roles for a Canvas Account — get_roles","text":"function retrieves paginated list roles available specific account Canvas LMS system.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_roles.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Roles for a Canvas Account — get_roles","text":"","code":"get_roles(canvas, account_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_roles.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Roles for a Canvas Account — get_roles","text":"canvas list containing base URL API key Canvas LMS instance. account_id ID account want retrieve roles. per_page number roles retrieve per page (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_roles.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Roles for a Canvas Account — get_roles","text":"data frame containing roles available specified account.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_information.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Section Information in Canvas LMS — get_section_information","title":"Get Section Information in Canvas LMS — get_section_information","text":"Retrieves information specific course section using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_information.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Section Information in Canvas LMS — get_section_information","text":"","code":"get_section_information(canvas, course_id, section_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_information.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Section Information in Canvas LMS — get_section_information","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course. section_id ID section.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_information.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Section Information in Canvas LMS — get_section_information","text":"information section.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_students.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Students in a Section — get_section_students","title":"Retrieve Students in a Section — get_section_students","text":"function retrieves list students enrolled specific section course Canvas LMS.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_students.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Students in a Section — get_section_students","text":"","code":"get_section_students(canvas, section_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_students.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Students in a Section — get_section_students","text":"canvas list containing Canvas API key base URL, typically obtained canvas_authenticate function. section_id ID section retrieve students. per_page (Optional) number student records retrieve per page results. Defaults 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_students.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Students in a Section — get_section_students","text":"data frame containing details students enrolled specified section.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_students.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve Students in a Section — get_section_students","text":"","code":"if (FALSE) { # \\dontrun{ 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) } # }"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_student_summaries.html","id":null,"dir":"Reference","previous_headings":"","what":"Get student summaries for a course from Canvas LMS API — get_student_summaries","title":"Get student summaries for a course from Canvas LMS API — get_student_summaries","text":"Retrieves student summaries specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_student_summaries.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get student summaries for a course from Canvas LMS API — get_student_summaries","text":"","code":"get_student_summaries(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_student_summaries.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get student summaries for a course from Canvas LMS API — get_student_summaries","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve student summaries. per_page Number student summaries retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_student_summaries.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get student summaries for a course from Canvas LMS API — get_student_summaries","text":"list student summaries retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_assignment_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Get user-in-a-course-level assignment data from the Canvas LMS API — get_user_course_assignment_data","title":"Get user-in-a-course-level assignment data from the Canvas LMS API — get_user_course_assignment_data","text":"Retrieves user---course-level assignment data specific course student Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_assignment_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get user-in-a-course-level assignment data from the Canvas LMS API — get_user_course_assignment_data","text":"","code":"get_user_course_assignment_data(canvas, course_id, student_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_assignment_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get user-in-a-course-level assignment data from the Canvas LMS API — get_user_course_assignment_data","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve assignment data. student_id ID student retrieve assignment data.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_assignment_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get user-in-a-course-level assignment data from the Canvas LMS API — get_user_course_assignment_data","text":"list user---course-level assignment data retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_messaging_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Get user-in-a-course-level messaging data from the Canvas LMS API — get_user_course_messaging_data","title":"Get user-in-a-course-level messaging data from the Canvas LMS API — get_user_course_messaging_data","text":"Retrieves user---course-level messaging data specific course student Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_messaging_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get user-in-a-course-level messaging data from the Canvas LMS API — get_user_course_messaging_data","text":"","code":"get_user_course_messaging_data(canvas, course_id, student_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_messaging_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get user-in-a-course-level messaging data from the Canvas LMS API — get_user_course_messaging_data","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve messaging data. student_id ID student retrieve messaging data.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_messaging_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get user-in-a-course-level messaging data from the Canvas LMS API — get_user_course_messaging_data","text":"list user---course-level messaging data retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_participation_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Get user-in-a-course-level participation data from the Canvas LMS API — get_user_course_participation_data","title":"Get user-in-a-course-level participation data from the Canvas LMS API — get_user_course_participation_data","text":"Retrieves user---course-level participation data specific course student Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_participation_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get user-in-a-course-level participation data from the Canvas LMS API — get_user_course_participation_data","text":"","code":"get_user_course_participation_data(canvas, course_id, student_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_participation_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get user-in-a-course-level participation data from the Canvas LMS API — get_user_course_participation_data","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve participation data. student_id ID student retrieve participation data.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_participation_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get user-in-a-course-level participation data from the Canvas LMS API — get_user_course_participation_data","text":"list user---course-level participation data retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/pipe.html","id":null,"dir":"Reference","previous_headings":"","what":"Pipe operator — %>%","title":"Pipe operator — %>%","text":"See magrittr::%>% details.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/pipe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pipe operator — %>%","text":"","code":"lhs %>% rhs"},{"path":"https://vusaverse.github.io/vvcanvas/reference/pipe.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pipe operator — %>%","text":"lhs value magrittr placeholder. rhs function call using magrittr semantics.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/pipe.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pipe operator — %>%","text":"result calling rhs(lhs).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/post_new_discussion.html","id":null,"dir":"Reference","previous_headings":"","what":"Post a New Discussion in Canvas LMS — post_new_discussion","title":"Post a New Discussion in Canvas LMS — post_new_discussion","text":"Creates new discussion topic specific course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/post_new_discussion.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Post a New Discussion in Canvas LMS — post_new_discussion","text":"","code":"post_new_discussion( canvas, course_id, discussion_title, discussion_message, discussion_is_announcement = FALSE )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/post_new_discussion.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Post a New Discussion in Canvas LMS — post_new_discussion","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create discussion. discussion_title title discussion topic. discussion_message initial message content discussion topic. discussion_is_announcement (Optional) Whether discussion announcement. Defaults FALSE.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/post_new_discussion.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Post a New Discussion in Canvas LMS — post_new_discussion","text":"confirmation message discussion created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/update_quiz.html","id":null,"dir":"Reference","previous_headings":"","what":"Modify an existing quiz. — update_quiz","title":"Modify an existing quiz. — update_quiz","text":"function modifies existing quiz specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/update_quiz.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Modify an existing quiz. — update_quiz","text":"","code":"update_quiz(canvas, course_id, quiz_id, quiz_params)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/update_quiz.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Modify an existing quiz. — update_quiz","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course containing quiz modified. quiz_id ID quiz modified. quiz_params named list quiz parameters update. list can include: title (string) quiz title. description (string) description quiz. quiz_type (string) type quiz. Allowed values: \"practice_quiz\", \"assignment\", \"graded_survey\", \"survey\". assignment_group_id (integer) assignment group id put assignment . Defaults top assignment group course. valid quiz graded. time_limit (integer) Time limit take quiz, minutes. Set NULL time limit. Defaults NULL. shuffle_answers (boolean) TRUE, quiz answers multiple choice questions randomized student. Defaults FALSE. hide_results (string) Dictates whether quiz results hidden students. Allowed values: \"always\", \"until_after_last_attempt\". Defaults NULL. show_correct_answers (boolean) FALSE, hides correct answers students quiz results viewed. Defaults TRUE. show_correct_answers_last_attempt (boolean) TRUE, hides correct answers students submit last attempt quiz. Defaults FALSE. show_correct_answers_at (DateTime) correct answers visible students date. hide_correct_answers_at (DateTime) correct answers stop visible date passed. allowed_attempts (integer) Number times student allowed take quiz. Set -1 unlimited attempts. Defaults 1. scoring_policy (string) Scoring policy quiz students can take multiple times. Allowed values: \"keep_highest\", \"keep_latest\". one_question_at_a_time (boolean) TRUE, shows quiz student one question time. Defaults FALSE. cant_go_back (boolean) TRUE, questions locked answering. Defaults FALSE. access_code (string) Restricts access quiz password. access code restriction, set NULL. ip_filter (string) Restricts access quiz computers specified IP range. due_at (DateTime) day/time quiz due. Accepts times ISO 8601 format, e.g., \"2011-10-21T18:48Z\". lock_at (DateTime) day/time quiz locked students. unlock_at (DateTime) day/time quiz unlocked students. published (boolean) Whether quiz published. one_time_results (boolean) Whether students prevented viewing quiz results past first time. Defaults FALSE. only_visible_to_overrides (boolean) Whether quiz visible overrides. Defaults FALSE. notify_of_update (boolean) TRUE, notifies users quiz changed. Defaults TRUE.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/update_quiz.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Modify an existing quiz. — update_quiz","text":"list representing updated quiz object.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/upload_qti_file_with_migration.html","id":null,"dir":"Reference","previous_headings":"","what":"Upload QTI File with Content Migration — upload_qti_file_with_migration","title":"Upload QTI File with Content Migration — upload_qti_file_with_migration","text":"function uploads QTI file specified course Canvas LMS initiates content migration. handles process creating migration, uploading file, checking migration status.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/upload_qti_file_with_migration.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Upload QTI File with Content Migration — upload_qti_file_with_migration","text":"","code":"upload_qti_file_with_migration( canvas, course_id, pre_attachment_name, pre_attachment_size, file_path, settings = list() )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/upload_qti_file_with_migration.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Upload QTI File with Content Migration — upload_qti_file_with_migration","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course QTI file uploaded. pre_attachment_name name file uploaded. required file upload process. pre_attachment_size size file uploaded bytes. required file upload process. file_path local file path QTI file needs uploaded. settings list additional settings content migration. can include options like question bank name overwrite settings.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/upload_qti_file_with_migration.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Upload QTI File with Content Migration — upload_qti_file_with_migration","text":"confirmation message indicating QTI file uploaded content migration completed.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/news/index.html","id":"vvcanvas-004","dir":"Changelog","previous_headings":"","what":"vvcanvas 0.0.4","title":"vvcanvas 0.0.4","text":"CRAN release: 2024-04-29 Added methods sections. Added methods favorites. Updated authentication method. Updated vignette. Added method calendar events. Added method account roles.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/news/index.html","id":"vvcanvas-003","dir":"Changelog","previous_headings":"","what":"vvcanvas 0.0.3","title":"vvcanvas 0.0.3","text":"CRAN release: 2023-10-23 Added methods Analytics endpoints.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/news/index.html","id":"vvcanvas-002","dir":"Changelog","previous_headings":"","what":"vvcanvas 0.0.2","title":"vvcanvas 0.0.2","text":"CRAN release: 2023-07-17 Added NEWS.md file track changes package. Introduced number POST actions. Added vignette based use case user.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/news/index.html","id":"vvcanvas-002-1","dir":"Changelog","previous_headings":"","what":"vvcanvas 0.0.2","title":"vvcanvas 0.0.2","text":"CRAN release: 2023-07-17 Published CRAN","code":""}] +[{"path":"https://vusaverse.github.io/vvcanvas/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2023 vvcanvas authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"vignette demonstrates upload QTI file Canvas LMS, retrieve list quizzes upload, update quiz parameters using R. process involves using get_course_quizzes update_quiz functions.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"step-1-authenticate-with-canvas","dir":"Articles","previous_headings":"","what":"Step 1: Authenticate with Canvas","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"First, authenticate Canvas creating canvas object containing API key base URL:","code":"canvas <- vvcanvas::canvas_authenticate()"},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"step-2-retrieve-the-list-of-quizzes","dir":"Articles","previous_headings":"","what":"Step 2: Retrieve the List of Quizzes","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"Retrieve list quizzes course uploading QTI file:","code":"course_id <- \"12345\" # Replace with your actual course ID quizzes_before <- get_course_quizzes(canvas, course_id)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"step-3-upload-the-qti-file","dir":"Articles","previous_headings":"","what":"Step 3: Upload the QTI File","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"Use upload_qti_file_with_migration function upload QTI file. function defined handle QTI file upload process:","code":"# Define the function if not already defined # Upload the QTI file file_path <- \"path/to/your/qti_file.zip\" # Replace with your actual file path upload_qti_file_with_migration(canvas, course_id = course_id, file_path = \"qti_file.zip\", pre_attachment_size = \"12345\", pre_attachment_name = \"test\")"},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"step-4-retrieve-quizzes-after-upload","dir":"Articles","previous_headings":"","what":"Step 4: Retrieve Quizzes After Upload","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"Retrieve list quizzes QTI file upload:","code":"quizzes_after <- get_course_quizzes(canvas, course_id) print(quizzes_after)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"step-5-identify-the-new-quiz","dir":"Articles","previous_headings":"","what":"Step 5: Identify the New Quiz","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"Compare lists quizzes upload identify newly created quiz:","code":"new_quiz <- setdiff(quizzes_after, quizzes_before) print(new_quiz)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"step-6-update-quiz-parameters","dir":"Articles","previous_headings":"","what":"Step 6: Update Quiz Parameters","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"Use update_quiz function modify parameters newly created quiz:","code":"quiz_id <- new_quiz$id # Assuming there's only one new quiz quiz_params <- list( title = \"Updated Quiz Title\", description = \"Updated description of the quiz.\", due_at = \"2013-01-23T23:59:00-07:00\" ) updated_quiz <- update_quiz(canvas, course_id, quiz_id, quiz_params) print(updated_quiz)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/QTI_quiz.html","id":"conclusion","dir":"Articles","previous_headings":"","what":"Conclusion","title":"Uploading QTI Files and Updating Quiz Parameters in Canvas LMS","text":"vignette demonstrated upload QTI file Canvas LMS, identify newly created quiz, update parameters. can extend process modify quiz attributes needed.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/articles/getting_started.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Getting Started","text":"vvcanvas package designed interact Canvas Learning Management System (LMS) API. vignette provides basic guide authenticate, retrieve course information, fetch specific details using package.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/articles/getting_started.html","id":"installation","dir":"Articles","previous_headings":"","what":"Installation","title":"Getting Started","text":"install vvcanvas package, can use following command:","code":"install_github(\"vusaverse/vvcanvas\") library(vvcanvas)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/getting_started.html","id":"authentication","dir":"Articles","previous_headings":"","what":"Authentication","title":"Getting Started","text":"start using package, need authenticate Canvas LMS API using API key base URL. ’s example authenticate:","code":"# Replace the placeholders with your API key and base URL api_key <- \"YOUR_API_KEY\" base_url <- \"https://your_canvas_domain.com/\" # Authenticate with the Canvas LMS API canvas <- canvas_authenticate(api_key, base_url) ## Alternatively, you can set system variables # Set the API key and base URL as environment variables Sys.setenv(CANVAS_API_KEY = \"YOUR_API_KEY\") Sys.setenv(CANVAS_BASE_URL = \"https://your_canvas_domain.com/\") # Authenticate with the Canvas LMS API canvas <- canvas_authenticate()"},{"path":"https://vusaverse.github.io/vvcanvas/articles/getting_started.html","id":"retrieving-course-information","dir":"Articles","previous_headings":"","what":"Retrieving Course Information","title":"Getting Started","text":"authenticated, can retrieve course information using get_courses function. ’s example:","code":"# Fetch the dataframe of courses courses <- get_courses(canvas) head(courses)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/getting_started.html","id":"fetching-specific-details","dir":"Articles","previous_headings":"","what":"Fetching Specific Details","title":"Getting Started","text":"vvcanvas package provides various functions fetch specific details. example, retrieve assignments within course, can use get_assignments function:","code":"# Replace the placeholder with the desired course ID course_id <- 12345 # Fetch the assignments for the course assignments <- get_assignments(canvas, course_id) head(assignments)"},{"path":"https://vusaverse.github.io/vvcanvas/articles/groups_use_case.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Working with groups","text":"vignette demonstrates retrieve group memberships course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/articles/groups_use_case.html","id":"step-1-list-courses","dir":"Articles","previous_headings":"","what":"Step 1: List courses","title":"Working with groups","text":"","code":"library(vvcanvas) # Specify the Canvas API authentication details canvas <- list( api_key = \"YOUR_API_KEY\", base_url = \"https://your_canvas_instance/\" ) # Retrieve all courses courses <- get_courses(canvas) # Select a course (replace the index with the desired course) course_id <- course$id[1] ## the first course in courses"},{"path":"https://vusaverse.github.io/vvcanvas/articles/groups_use_case.html","id":"step-2-retrieve-all-groups-in-the-course","dir":"Articles","previous_headings":"","what":"Step 2: Retrieve all groups in the course","title":"Working with groups","text":"","code":"# Retrieve all groups in the selected course groups <- get_course_groups(canvas, course_id) # Extract the group IDs group_ids <- groups$id"},{"path":"https://vusaverse.github.io/vvcanvas/articles/groups_use_case.html","id":"step-3-retrieve-group-memberships","dir":"Articles","previous_headings":"","what":"Step 3: Retrieve group memberships","title":"Working with groups","text":"","code":"# Retrieve group memberships using purrr memberships <- purrr::map_df(group_ids, ~{ group_id <- .x # Retrieve the group's memberships group_memberships <- get_group_users(canvas, group_id) # Extract user names from memberships user_names <- group_memberships$name # Create a data frame with group memberships group_df <- data.frame(group_id = rep(group_id, length(user_names)), user_name = user_names, stringsAsFactors = FALSE) return(group_df) })"},{"path":"https://vusaverse.github.io/vvcanvas/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Tomer Iwan. Author, maintainer, copyright holder.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Iwan T (2024). vvcanvas: 'Canvas' LMS API Integration. R package version 0.0.4, https://vusaverse.github.io/vvcanvas/, https://github.com/vusaverse/vvcanvas.","code":"@Manual{, title = {vvcanvas: 'Canvas' LMS API Integration}, author = {Tomer Iwan}, year = {2024}, note = {R package version 0.0.4, https://vusaverse.github.io/vvcanvas/}, url = {https://github.com/vusaverse/vvcanvas}, }"},{"path":"https://vusaverse.github.io/vvcanvas/index.html","id":"vvcanvas-","dir":"","previous_headings":"","what":"Canvas LMS API Integration","title":"Canvas LMS API Integration","text":"vvcanvas package R library provides convenient interface interact Canvas Learning Management System (LMS) API. allows users authenticate, retrieve course information, fetch specific details, perform various operations within Canvas LMS.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Canvas LMS API Integration","text":"can install vvcanvas package GitHub using following command: also possible install CRAN:","code":"devtools::install_github(\"vusaverse/vvcanvas\") install.packages(\"vvcanvas\")"},{"path":"https://vusaverse.github.io/vvcanvas/index.html","id":"features","dir":"","previous_headings":"","what":"Features","title":"Canvas LMS API Integration","text":"see functions available section based CANVAS LMS API structure, please refer reference page vvcanvas package. reference page provides comprehensive list functions available package, organized category. Additionally, package includes vignettes provide detailed information use functions package.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/index.html","id":"getting-started","dir":"","previous_headings":"","what":"Getting Started","title":"Canvas LMS API Integration","text":"begin using vvcanvas package, need authenticate Canvas LMS API obtaining API key base URL. Follow steps get started: Acquire API key Canvas LMS instance. may need consult Canvas administrator refer Canvas API documentation instructions obtaining API key. API key, load vvcanvas library use canvas_authenticate function authenticate Canvas LMS API. Provide API key base URL Canvas instance parameters. ’s example: authentication step completed, can now utilize various functions provided vvcanvas package interact Canvas LMS. order retrieve dataframe courses can use following function:","code":"library(vvcanvas) # Replace the placeholders with your API key and base URL api_key <- \"YOUR_API_KEY\" base_url <- \"https://your_canvas_domain.com/\" # Authenticate with the Canvas LMS API canvas <- canvas_authenticate(api_key, base_url) ## Alternatively, you can set system variables # Set the API key and base URL as environment variables Sys.setenv(CANVAS_API_KEY = \"YOUR_API_KEY\") Sys.setenv(CANVAS_BASE_URL = \"https://your_canvas_domain.com/\") # Authenticate with the Canvas LMS API canvas <- canvas_authenticate() # Pass the canvas object to the get_courses function courses <- get_courses(canvas)"},{"path":"https://vusaverse.github.io/vvcanvas/index.html","id":"canvas-analytics-project","dir":"","previous_headings":"","what":"Canvas Analytics Project","title":"Canvas LMS API Integration","text":"canvas-analytics project provides data pipeline extracting, aggregating, analyzing data Canvas Learning Management System (LMS) using vvcanvas package. aims facilitate data retrieval analysis student, course, program levels, enabling data-driven insights decision-making education learning analytics. Key features include: Data extraction Canvas LMS API Data aggregation different levels (student, course, program) Data visualization reporting Reproducible extensible analysis workflow","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_api_key.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the Canvas API key from the environment variable — canvas_api_key","title":"Get the Canvas API key from the environment variable — canvas_api_key","text":"Get Canvas API key environment variable","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_api_key.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the Canvas API key from the environment variable — canvas_api_key","text":"","code":"canvas_api_key()"},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_api_key.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the Canvas API key from the environment variable — canvas_api_key","text":"Canvas API key stored CANVAS_API_KEY environment variable.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_authenticate.html","id":null,"dir":"Reference","previous_headings":"","what":"Authenticate with Canvas LMS API — canvas_authenticate","title":"Authenticate with Canvas LMS API — canvas_authenticate","text":"function handles authentication Canvas LMS API. uses provided API key base URL, falls back CANVAS_API_KEY CANVAS_BASE_URL environment variables none provided.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_authenticate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Authenticate with Canvas LMS API — canvas_authenticate","text":"","code":"canvas_authenticate(api_key = canvas_api_key(), base_url = canvas_base_url())"},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_authenticate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Authenticate with Canvas LMS API — canvas_authenticate","text":"api_key API key authenticating Canvas LMS API. Defaults CANVAS_API_KEY environment variable. base_url base URL Canvas instance. Defaults CANVAS_BASE_URL environment variable.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_authenticate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Authenticate with Canvas LMS API — canvas_authenticate","text":"list containing authenticated 'api_key' 'base_url'.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_authenticate.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Authenticate with Canvas LMS API — canvas_authenticate","text":"function verifies authentication making test request /api/v1/users/self endpoint Canvas instance. response status code 200, throws error message indicating authentication failed.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_authenticate.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Authenticate with Canvas LMS API — canvas_authenticate","text":"","code":"if (FALSE) { # \\dontrun{ # Authenticate with the Canvas LMS API api_key <- \"your_api_key\" base_url <- \"https://canvas.example.com\" canvas <- canvas_authenticate(api_key, base_url) } # }"},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_base_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the Canvas base URL from the environment variable — canvas_base_url","title":"Get the Canvas base URL from the environment variable — canvas_base_url","text":"Get Canvas base URL environment variable","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_base_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the Canvas base URL from the environment variable — canvas_base_url","text":"","code":"canvas_base_url()"},{"path":"https://vusaverse.github.io/vvcanvas/reference/canvas_base_url.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the Canvas base URL from the environment variable — canvas_base_url","text":"Canvas base URL stored CANVAS_BASE_URL environment variable.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_assignment_group.html","id":null,"dir":"Reference","previous_headings":"","what":"Create an Assignment Group in Canvas LMS — create_assignment_group","title":"Create an Assignment Group in Canvas LMS — create_assignment_group","text":"Creates new assignment group specific course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_assignment_group.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create an Assignment Group in Canvas LMS — create_assignment_group","text":"","code":"create_assignment_group(canvas, course_id, group_name, group_position = NULL)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_assignment_group.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create an Assignment Group in Canvas LMS — create_assignment_group","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create assignment group. group_name name assignment group. group_position position assignment group course (optional).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_assignment_group.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create an Assignment Group in Canvas LMS — create_assignment_group","text":"confirmation message assignment group created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_datalake.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a data lake for a course. — create_course_datalake","title":"Create a data lake for a course. — create_course_datalake","text":"function retrieves data various endpoints specific course Canvas LMS API stores data JSON files specified storage location.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_datalake.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a data lake for a course. — create_course_datalake","text":"","code":"create_course_datalake(canvas, course_id, storage_location)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_datalake.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a data lake for a course. — create_course_datalake","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course create data lake. storage_location path storage location data files saved.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_datalake.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a data lake for a course. — create_course_datalake","text":"NULL.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_datalake.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Create a data lake for a course. — create_course_datalake","text":"function retrieves data various endpoints. Access certain endpoints may require specific roles.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_section.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Course Section in Canvas LMS — create_course_section","title":"Create a Course Section in Canvas LMS — create_course_section","text":"Creates new course section specific course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_section.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Course Section in Canvas LMS — create_course_section","text":"","code":"create_course_section( canvas, course_id, section_name, section_start_date = NULL, section_end_date = NULL )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_section.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Course Section in Canvas LMS — create_course_section","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create section. section_name name section. section_start_date (Optional) start date section. section_end_date (Optional) end date section.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_course_section.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Course Section in Canvas LMS — create_course_section","text":"confirmation message section created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_folder.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Folder in Canvas LMS — create_folder","title":"Create a Folder in Canvas LMS — create_folder","text":"Creates new folder specific course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_folder.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Folder in Canvas LMS — create_folder","text":"","code":"create_folder(canvas, course_id, folder_name, parent_folder_id = NULL)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_folder.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Folder in Canvas LMS — create_folder","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create folder. folder_name name folder. parent_folder_id (Optional) ID parent folder create folder.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_folder.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Folder in Canvas LMS — create_folder","text":"confirmation message folder created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_group_category.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Group Category in Canvas LMS — create_group_category","title":"Create a Group Category in Canvas LMS — create_group_category","text":"Creates new group category specific course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_group_category.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Group Category in Canvas LMS — create_group_category","text":"","code":"create_group_category( canvas, course_id, category_name, allow_self_signup = FALSE )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_group_category.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Group Category in Canvas LMS — create_group_category","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create group category. category_name name group category. allow_self_signup (Optional) Whether allow self-signup groups category. Defaults FALSE.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_group_category.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Group Category in Canvas LMS — create_group_category","text":"confirmation message group category created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_module.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Module in Canvas LMS — create_module","title":"Create a Module in Canvas LMS — create_module","text":"Creates new module specific course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_module.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Module in Canvas LMS — create_module","text":"","code":"create_module(canvas, course_id, module_name, position = NULL)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_module.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Module in Canvas LMS — create_module","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create module. module_name title module. position (Optional) position module course","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_module.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Module in Canvas LMS — create_module","text":"confirmation message module created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_module_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Module Item in Canvas LMS — create_module_item","title":"Create a Module Item in Canvas LMS — create_module_item","text":"Creates new item specific module specifc course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_module_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Module Item in Canvas LMS — create_module_item","text":"","code":"create_module_item( canvas, course_id, module_id, item_title, item_type = \"Page\", position = NULL, page_url = NULL, page_id = NULL )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_module_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Module Item in Canvas LMS — create_module_item","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create module item. module_id ID module create item. item_title title new item within module. item_type type item. Defaults \"Page\". position (Optional) position item within module. Defaults 1. page_url (Optional) url page. page_id (Optional) id page.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_module_item.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Module Item in Canvas LMS — create_module_item","text":"confirmation message page created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_page.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Page in Canvas LMS — create_page","title":"Create a Page in Canvas LMS — create_page","text":"Creates new page specific course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_page.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Page in Canvas LMS — create_page","text":"","code":"create_page(canvas, course_id, page_title, page_body, published = FALSE)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_page.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Page in Canvas LMS — create_page","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create page. page_title title page. page_body body/content page. published (Optional) Whether page published. Defaults FALSE.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/create_page.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Page in Canvas LMS — create_page","text":"confirmation message page created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/delete_course_section.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a Course Section in Canvas LMS — delete_course_section","title":"Delete a Course Section in Canvas LMS — delete_course_section","text":"Deletes existing course section using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/delete_course_section.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a Course Section in Canvas LMS — delete_course_section","text":"","code":"delete_course_section(canvas, section_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/delete_course_section.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a Course Section in Canvas LMS — delete_course_section","text":"canvas list containing 'api_key' 'base_url' authentication. section_id ID section delete.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/delete_course_section.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a Course Section in Canvas LMS — delete_course_section","text":"confirmation message section deleted.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/download_course_file.html","id":null,"dir":"Reference","previous_headings":"","what":"Downloads a file from a given URL. — download_course_file","title":"Downloads a file from a given URL. — download_course_file","text":"function downloads file specified URL saves locally.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/download_course_file.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Downloads a file from a given URL. — download_course_file","text":"","code":"download_course_file(canvas, file_url, download_path)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/download_course_file.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Downloads a file from a given URL. — download_course_file","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. file_url URL file download. download_path path file downloaded.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/download_course_file.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Downloads a file from a given URL. — download_course_file","text":"path downloaded file.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/download_course_file.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Downloads a file from a given URL. — download_course_file","text":"","code":"if (FALSE) { # \\dontrun{ # Download a file from a given URL canvas <- canvas_authenticate(api_key, base_url) file_url <- \"https://example.com/file.pdf\" download_path <- \"path/to/save/file.pdf\" file_path <- download_course_file(canvas, file_url, download_path) } # }"},{"path":"https://vusaverse.github.io/vvcanvas/reference/edit_section.html","id":null,"dir":"Reference","previous_headings":"","what":"Edit a Course Section in Canvas LMS — edit_section","title":"Edit a Course Section in Canvas LMS — edit_section","text":"Modifies existing course section using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/edit_section.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Edit a Course Section in Canvas LMS — edit_section","text":"","code":"edit_section( canvas, section_id, section_name = NULL, sis_section_id = NULL, integration_id = NULL, section_start_date = NULL, section_end_date = NULL, restrict_enrollments_to_section_dates = NULL, override_sis_stickiness = NULL )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/edit_section.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Edit a Course Section in Canvas LMS — edit_section","text":"canvas list containing 'api_key' 'base_url' authentication. section_id ID section edit. section_name new name section (optional). sis_section_id new SIS ID section (optional). integration_id new integration ID section (optional). section_start_date new start date section (optional). section_end_date new end date section (optional). restrict_enrollments_to_section_dates Whether restrict user enrollments start end dates section (optional). override_sis_stickiness Whether override SIS stickiness (optional).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/edit_section.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Edit a Course Section in Canvas LMS — edit_section","text":"confirmation message section edited.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_accounts.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a list of accounts from the Canvas LMS API — get_accounts","title":"Get a list of accounts from the Canvas LMS API — get_accounts","text":"Retrieves paginated list accounts current user can view manage.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_accounts.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a list of accounts from the Canvas LMS API — get_accounts","text":"","code":"get_accounts(canvas, include = NULL, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_accounts.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a list of accounts from the Canvas LMS API — get_accounts","text":"canvas list containing 'api_key' 'base_url' authentication. include vector additional information include. Default NULL. per_page Number accounts retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_accounts.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a list of accounts from the Canvas LMS API — get_accounts","text":"list accounts retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_all_courses.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves a paginated list of all courses visible in the public index. — get_all_courses","title":"Retrieves a paginated list of all courses visible in the public index. — get_all_courses","text":"function retrieves paginated list courses visible public index using Canvas LMS API. NOTE function might take finish.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_all_courses.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves a paginated list of all courses visible in the public index. — get_all_courses","text":"","code":"get_all_courses(canvas, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_all_courses.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves a paginated list of all courses visible in the public index. — get_all_courses","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. per_page (Optional) number courses retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_all_courses.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves a paginated list of all courses visible in the public index. — get_all_courses","text":"data frame courses visible public index.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Get course-level assignment data from the Canvas LMS API — get_assignment_data","title":"Get course-level assignment data from the Canvas LMS API — get_assignment_data","text":"Retrieves course-level assignment data specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get course-level assignment data from the Canvas LMS API — get_assignment_data","text":"","code":"get_assignment_data(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get course-level assignment data from the Canvas LMS API — get_assignment_data","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve assignment data. per_page Number assignment data retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get course-level assignment data from the Canvas LMS API — get_assignment_data","text":"list assignment data retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_details.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Assignment Details from Canvas LMS API — get_assignment_details","title":"Get Assignment Details from Canvas LMS API — get_assignment_details","text":"Retrieves detailed information specific assignment Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_details.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Assignment Details from Canvas LMS API — get_assignment_details","text":"","code":"get_assignment_details(canvas, course_id, assignment_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_details.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Assignment Details from Canvas LMS API — get_assignment_details","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course assignment resides. assignment_id ID assignment retrieve details.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_details.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Assignment Details from Canvas LMS API — get_assignment_details","text":"dataframe containing detailed information assignment.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_groups.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the assignment groups within a course. — get_assignment_groups","title":"Retrieves the assignment groups within a course. — get_assignment_groups","text":"function retrieves assignment groups within specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_groups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the assignment groups within a course. — get_assignment_groups","text":"","code":"get_assignment_groups(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_groups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the assignment groups within a course. — get_assignment_groups","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch assignment groups. per_page number entries show per page.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_groups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the assignment groups within a course. — get_assignment_groups","text":"list assignment groups within specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_submissions.html","id":null,"dir":"Reference","previous_headings":"","what":"Lists assignment submissions for a course. — get_assignment_submissions","title":"Lists assignment submissions for a course. — get_assignment_submissions","text":"function retrieves list assignment submissions specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_submissions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lists assignment submissions for a course. — get_assignment_submissions","text":"","code":"get_assignment_submissions( canvas, course_id, assignment_id = NULL, per_page = 100 )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_submissions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lists assignment submissions for a course. — get_assignment_submissions","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course list assignment submissions. assignment_id (Optional) ID specific assignment list submissions. per_page (Optional) number submissions retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignment_submissions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lists assignment submissions for a course. — get_assignment_submissions","text":"data frame assignment submissions specified course assignment.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignments.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Assignments from Canvas LMS API — get_assignments","title":"Get Assignments from Canvas LMS API — get_assignments","text":"Fetches list assignments within specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignments.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Assignments from Canvas LMS API — get_assignments","text":"","code":"get_assignments(canvas, course_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignments.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Assignments from Canvas LMS API — get_assignments","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve assignments.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_assignments.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Assignments from Canvas LMS API — get_assignments","text":"list assignments retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_calendar_events.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Calendar Events from Canvas LMS API — get_calendar_events","title":"Get Calendar Events from Canvas LMS API — get_calendar_events","text":"Retrieve paginated list calendar events assignments current user.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_calendar_events.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Calendar Events from Canvas LMS API — get_calendar_events","text":"","code":"get_calendar_events( canvas, type = \"event\", start_date = NULL, end_date = NULL, undated = FALSE, all_events = FALSE, context_codes = NULL, excludes = NULL, includes = NULL, important_dates = FALSE, blackout_date = FALSE )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_calendar_events.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Calendar Events from Canvas LMS API — get_calendar_events","text":"canvas list containing 'api_key' 'base_url' authentication. type type events retrieve. Default \"event\". Allowed values: event, assignment. start_date return events since start_date (inclusive). Defaults today. end_date return events end_date (inclusive). Defaults start_date. undated Defaults false (dated events ). true, return undated events ignore start_date end_date. all_events Defaults false (uses start_date, end_date, undated criteria). true, events returned, ignoring start_date, end_date, undated criteria. context_codes List context codes courses, groups, users, accounts whose events want see. specified, defaults current user (.e personal calendar, course/group events). excludes Array attributes exclude. Possible values “description”, “child_events” “assignment”. includes Array optional attributes include. Possible values “web_conference” calendar_series flag , “series_natural_language”. important_dates Defaults false. true, events important dates set true returned. blackout_date Defaults false. true, events blackout date set true returned.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_calendar_events.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Calendar Events from Canvas LMS API — get_calendar_events","text":"data frame calendar events retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_announcements.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves course announcements. — get_course_announcements","title":"Retrieves course announcements. — get_course_announcements","text":"function retrieves list announcements specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_announcements.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves course announcements. — get_course_announcements","text":"","code":"get_course_announcements(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_announcements.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves course announcements. — get_course_announcements","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course retrieve announcements. per_page (Optional) number announcements retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_announcements.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves course announcements. — get_course_announcements","text":"data frame course announcements.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_details.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Course Details from Canvas LMS API — get_course_details","title":"Get Course Details from Canvas LMS API — get_course_details","text":"Retrieves detailed information specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_details.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Course Details from Canvas LMS API — get_course_details","text":"","code":"get_course_details(canvas, course_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_details.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Course Details from Canvas LMS API — get_course_details","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve details.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_details.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Course Details from Canvas LMS API — get_course_details","text":"dataframe containing detailed information course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_enrollments.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the course enrollments for a course. — get_course_enrollments","title":"Retrieves the course enrollments for a course. — get_course_enrollments","text":"function retrieves enrollments students roles specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_enrollments.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the course enrollments for a course. — get_course_enrollments","text":"","code":"get_course_enrollments(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_enrollments.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the course enrollments for a course. — get_course_enrollments","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch enrollments. per_page (Optional) number enrollments retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_enrollments.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the course enrollments for a course. — get_course_enrollments","text":"data frame course enrollments specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_files.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves a list of files within a course. — get_course_files","title":"Retrieves a list of files within a course. — get_course_files","text":"function retrieves list files within specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_files.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves a list of files within a course. — get_course_files","text":"","code":"get_course_files(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_files.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves a list of files within a course. — get_course_files","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch files. per_page (Optional) number files retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_files.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves a list of files within a course. — get_course_files","text":"data frame files within specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_folders.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves course folders. — get_course_folders","title":"Retrieves course folders. — get_course_folders","text":"function retrieves list folders specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_folders.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves course folders. — get_course_folders","text":"","code":"get_course_folders(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_folders.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves course folders. — get_course_folders","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course retrieve folders. per_page Number courses retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_folders.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves course folders. — get_course_folders","text":"data frame course folders.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_groups.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the list of groups in a course. — get_course_groups","title":"Retrieves the list of groups in a course. — get_course_groups","text":"function retrieves list groups specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_groups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the list of groups in a course. — get_course_groups","text":"","code":"get_course_groups(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_groups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the list of groups in a course. — get_course_groups","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course fetch groups. per_page (Optional) number groups retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_groups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the list of groups in a course. — get_course_groups","text":"data frame groups specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_media_objects.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the media objects in a course. — get_course_media_objects","title":"Retrieves the media objects in a course. — get_course_media_objects","text":"function retrieves media objects associated specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_media_objects.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the media objects in a course. — get_course_media_objects","text":"","code":"get_course_media_objects(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_media_objects.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the media objects in a course. — get_course_media_objects","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch media objects. per_page number entries show per page.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_media_objects.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the media objects in a course. — get_course_media_objects","text":"data frame containing media objects specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_pages.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the pages within a course. — get_course_pages","title":"Retrieves the pages within a course. — get_course_pages","text":"function retrieves pages within specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_pages.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the pages within a course. — get_course_pages","text":"","code":"get_course_pages(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_pages.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the pages within a course. — get_course_pages","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch pages. per_page (Optional) number pages retrieve per page results (default 50).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_pages.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the pages within a course. — get_course_pages","text":"list pages within specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_participation.html","id":null,"dir":"Reference","previous_headings":"","what":"Get course-level participation data from Canvas LMS API — get_course_participation","title":"Get course-level participation data from Canvas LMS API — get_course_participation","text":"Fetches participation data specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_participation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get course-level participation data from Canvas LMS API — get_course_participation","text":"","code":"get_course_participation(canvas, course_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_participation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get course-level participation data from Canvas LMS API — get_course_participation","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve participation data.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_participation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get course-level participation data from Canvas LMS API — get_course_participation","text":"participation data specified course retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_quizzes.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves course quizzes. — get_course_quizzes","title":"Retrieves course quizzes. — get_course_quizzes","text":"function retrieves list quizzes specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_quizzes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves course quizzes. — get_course_quizzes","text":"","code":"get_course_quizzes(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_quizzes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves course quizzes. — get_course_quizzes","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course retrieve quizzes. per_page (Optional) number quizzes retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_quizzes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves course quizzes. — get_course_quizzes","text":"data frame course quizzes.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_sections.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves course sections. — get_course_sections","title":"Retrieves course sections. — get_course_sections","text":"function retrieves list sections specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_sections.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves course sections. — get_course_sections","text":"","code":"get_course_sections(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_sections.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves course sections. — get_course_sections","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course retrieve sections. per_page (Optional) number sections retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_sections.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves course sections. — get_course_sections","text":"data frame course sections.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_students.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the list of students in a course. — get_course_students","title":"Retrieves the list of students in a course. — get_course_students","text":"function retrieves list students enrolled specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_students.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the list of students in a course. — get_course_students","text":"","code":"get_course_students(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_students.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the list of students in a course. — get_course_students","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch students. per_page (Optional) number students retrieve per page results (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_students.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the list of students in a course. — get_course_students","text":"data frame students enrolled specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_users.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the users in a course. — get_course_users","title":"Retrieves the users in a course. — get_course_users","text":"function retrieves users enrolled specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_users.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the users in a course. — get_course_users","text":"","code":"get_course_users( canvas, course_id, per_page = 100, include = c(\"enrollments\", \"locked\", \"avatar_url\", \"test_student\", \"bio\", \"custom_links\", \"current_grading_period_scores\", \"uuid\") )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_users.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the users in a course. — get_course_users","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch users. per_page number entries show per page. include Optional parameters include response. Possible values: \"enrollments\", \"locked\", \"avatar_url\", \"test_student\", \"bio\", \"custom_links\", \"current_grading_period_scores\", \"uuid\".","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_course_users.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the users in a course. — get_course_users","text":"data frame containing users specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_courses.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Courses from Canvas LMS API — get_courses","title":"Get Courses from Canvas LMS API — get_courses","text":"Retrieves list courses Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_courses.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Courses from Canvas LMS API — get_courses","text":"","code":"get_courses(canvas, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_courses.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Courses from Canvas LMS API — get_courses","text":"canvas list containing 'api_key' 'base_url' authentication. per_page Number courses retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_courses.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Courses from Canvas LMS API — get_courses","text":"list courses retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_grade_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Get department-level grade data from the Canvas LMS API — get_department_grade_data","title":"Get department-level grade data from the Canvas LMS API — get_department_grade_data","text":"Retrieves department-level grade data specific account term Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_grade_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get department-level grade data from the Canvas LMS API — get_department_grade_data","text":"","code":"get_department_grade_data( canvas, account_id, type = \"current\", term_id = NULL, per_page = 100 )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_grade_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get department-level grade data from the Canvas LMS API — get_department_grade_data","text":"canvas list containing 'api_key' 'base_url' authentication. account_id ID account retrieve grade data. type type courses include data. Can 'current', 'completed', 'term'. term_id ID term retrieve grade data. used type 'terms/'. per_page Number grade data retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_grade_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get department-level grade data from the Canvas LMS API — get_department_grade_data","text":"data frame grade data retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_participation_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Get department-level participation data from the Canvas LMS API — get_department_participation_data","title":"Get department-level participation data from the Canvas LMS API — get_department_participation_data","text":"Retrieves department-level participation data specific account term Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_participation_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get department-level participation data from the Canvas LMS API — get_department_participation_data","text":"","code":"get_department_participation_data( canvas, account_id, type = \"current\", term_id = NULL, per_page = 100 )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_participation_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get department-level participation data from the Canvas LMS API — get_department_participation_data","text":"canvas list containing 'api_key' 'base_url' authentication. account_id ID account retrieve participation data. type type courses include data. Can 'current', 'completed', 'term'. term_id ID term retrieve participation data. used type 'terms/'. per_page Number participation data retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_participation_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get department-level participation data from the Canvas LMS API — get_department_participation_data","text":"data frame participation data retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics.html","id":null,"dir":"Reference","previous_headings":"","what":"Get department-level statistics from the Canvas LMS API — get_department_statistics","title":"Get department-level statistics from the Canvas LMS API — get_department_statistics","text":"Retrieves department-level statistics specific account term Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get department-level statistics from the Canvas LMS API — get_department_statistics","text":"","code":"get_department_statistics(canvas, account_id, type = \"current\", term_id = NULL)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get department-level statistics from the Canvas LMS API — get_department_statistics","text":"canvas list containing 'api_key' 'base_url' authentication. account_id ID account retrieve statistics. type type courses include data. Can 'current', 'completed', 'term'. term_id ID term retrieve statistics. used type 'terms/'.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get department-level statistics from the Canvas LMS API — get_department_statistics","text":"list department-level statistics retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics_by_subaccount.html","id":null,"dir":"Reference","previous_headings":"","what":"Get department-level statistics by subaccount from the Canvas LMS API — get_department_statistics_by_subaccount","title":"Get department-level statistics by subaccount from the Canvas LMS API — get_department_statistics_by_subaccount","text":"Retrieves department-level statistics specific account term Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics_by_subaccount.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get department-level statistics by subaccount from the Canvas LMS API — get_department_statistics_by_subaccount","text":"","code":"get_department_statistics_by_subaccount( canvas, account_id, type = \"current\", term_id = NULL )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics_by_subaccount.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get department-level statistics by subaccount from the Canvas LMS API — get_department_statistics_by_subaccount","text":"canvas list containing 'api_key' 'base_url' authentication. account_id ID account retrieve statistics. type type courses include data. Can 'current', 'completed', 'term'. term_id ID term retrieve statistics. used type 'terms/'.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_department_statistics_by_subaccount.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get department-level statistics by subaccount from the Canvas LMS API — get_department_statistics_by_subaccount","text":"list department-level statistics retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_discussions.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the discussion topics within a course. — get_discussions","title":"Retrieves the discussion topics within a course. — get_discussions","text":"function retrieves discussion topics within specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_discussions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the discussion topics within a course. — get_discussions","text":"","code":"get_discussions(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_discussions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the discussion topics within a course. — get_discussions","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch discussion topics. per_page number entries show","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_discussions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the discussion topics within a course. — get_discussions","text":"list discussion topics within specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_favorite_courses.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Favorite Courses in Canvas LMS — get_favorite_courses","title":"Get Favorite Courses in Canvas LMS — get_favorite_courses","text":"Retrieves data favorite courses authenticated user using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_favorite_courses.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Favorite Courses in Canvas LMS — get_favorite_courses","text":"","code":"get_favorite_courses(canvas, exclude_blueprint_courses = NULL)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_favorite_courses.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Favorite Courses in Canvas LMS — get_favorite_courses","text":"canvas list containing 'api_key' 'base_url' authentication. exclude_blueprint_courses set, return courses configured blueprint courses (optional).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_favorite_courses.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Favorite Courses in Canvas LMS — get_favorite_courses","text":"dataframe favorite courses.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_categories.html","id":null,"dir":"Reference","previous_headings":"","what":"Get group categories for a context — get_group_categories","title":"Get group categories for a context — get_group_categories","text":"function retrieves group categories specific context (e.g., course) Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_categories.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get group categories for a context — get_group_categories","text":"","code":"get_group_categories(canvas, course_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_categories.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get group categories for a context — get_group_categories","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve group categories.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_categories.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get group categories for a context — get_group_categories","text":"data frame group categories specified context.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Get information about a single group — get_group_info","title":"Get information about a single group — get_group_info","text":"function retrieves information specific group Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get information about a single group — get_group_info","text":"","code":"get_group_info(canvas, group_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get information about a single group — get_group_info","text":"canvas list containing 'api_key' 'base_url' authentication. group_id ID group retrieve information.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get information about a single group — get_group_info","text":"list containing information specified group.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_memberships.html","id":null,"dir":"Reference","previous_headings":"","what":"Get group memberships — get_group_memberships","title":"Get group memberships — get_group_memberships","text":"function retrieves memberships specific group Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_memberships.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get group memberships — get_group_memberships","text":"","code":"get_group_memberships(canvas, group_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_memberships.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get group memberships — get_group_memberships","text":"canvas list containing 'api_key' 'base_url' authentication. group_id ID group retrieve memberships.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_memberships.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get group memberships — get_group_memberships","text":"data frame memberships specified group.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_users.html","id":null,"dir":"Reference","previous_headings":"","what":"Get users in a group — get_group_users","title":"Get users in a group — get_group_users","text":"function retrieves users specific group Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_users.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get users in a group — get_group_users","text":"","code":"get_group_users(canvas, group_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_users.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get users in a group — get_group_users","text":"canvas list containing 'api_key' 'base_url' authentication. group_id ID group retrieve users.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_group_users.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get users in a group — get_group_users","text":"data frame users specified group.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_module_items.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the items within a specific module. — get_module_items","title":"Retrieves the items within a specific module. — get_module_items","text":"function retrieves items within specific module course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_module_items.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the items within a specific module. — get_module_items","text":"","code":"get_module_items(canvas, course_id, module_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_module_items.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the items within a specific module. — get_module_items","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course containing module. module_id ID module fetch items.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_module_items.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the items within a specific module. — get_module_items","text":"list items within specified module.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_modules.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the modules within a course. — get_modules","title":"Retrieves the modules within a course. — get_modules","text":"function retrieves modules within specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_modules.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the modules within a course. — get_modules","text":"","code":"get_modules(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_modules.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the modules within a course. — get_modules","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course fetch modules. per_page number entries show","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_modules.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the modules within a course. — get_modules","text":"list modules within specified course.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_page_content.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves the content body of a specified page. — get_page_content","title":"Retrieves the content body of a specified page. — get_page_content","text":"function retrieves content body specified page within course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_page_content.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves the content body of a specified page. — get_page_content","text":"","code":"get_page_content(canvas, course_id, page_id, return_as_plain_text = TRUE)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_page_content.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieves the content body of a specified page. — get_page_content","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course page belongs. page_id ID page fetch content body. return_as_plain_text logical value indicating whether return content plain text (default TRUE).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_page_content.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves the content body of a specified page. — get_page_content","text":"content body specified page, either plain text raw HTML.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_roles.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Roles for a Canvas Account — get_roles","title":"Retrieve Roles for a Canvas Account — get_roles","text":"function retrieves paginated list roles available specific account Canvas LMS system.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_roles.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Roles for a Canvas Account — get_roles","text":"","code":"get_roles(canvas, account_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_roles.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Roles for a Canvas Account — get_roles","text":"canvas list containing base URL API key Canvas LMS instance. account_id ID account want retrieve roles. per_page number roles retrieve per page (default 100).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_roles.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Roles for a Canvas Account — get_roles","text":"data frame containing roles available specified account.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_information.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Section Information in Canvas LMS — get_section_information","title":"Get Section Information in Canvas LMS — get_section_information","text":"Retrieves information specific course section using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_information.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Section Information in Canvas LMS — get_section_information","text":"","code":"get_section_information(canvas, course_id, section_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_information.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Section Information in Canvas LMS — get_section_information","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course. section_id ID section.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_information.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Section Information in Canvas LMS — get_section_information","text":"information section.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_students.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Students in a Section — get_section_students","title":"Retrieve Students in a Section — get_section_students","text":"function retrieves list students enrolled specific section course Canvas LMS.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_students.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Students in a Section — get_section_students","text":"","code":"get_section_students(canvas, section_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_students.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Students in a Section — get_section_students","text":"canvas list containing Canvas API key base URL, typically obtained canvas_authenticate function. section_id ID section retrieve students. per_page (Optional) number student records retrieve per page results. Defaults 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_students.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Students in a Section — get_section_students","text":"data frame containing details students enrolled specified section.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_section_students.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve Students in a Section — get_section_students","text":"","code":"if (FALSE) { # \\dontrun{ 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) } # }"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_student_summaries.html","id":null,"dir":"Reference","previous_headings":"","what":"Get student summaries for a course from Canvas LMS API — get_student_summaries","title":"Get student summaries for a course from Canvas LMS API — get_student_summaries","text":"Retrieves student summaries specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_student_summaries.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get student summaries for a course from Canvas LMS API — get_student_summaries","text":"","code":"get_student_summaries(canvas, course_id, per_page = 100)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_student_summaries.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get student summaries for a course from Canvas LMS API — get_student_summaries","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve student summaries. per_page Number student summaries retrieve per page. Default 100.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_student_summaries.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get student summaries for a course from Canvas LMS API — get_student_summaries","text":"list student summaries retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_assignment_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Get user-in-a-course-level assignment data from the Canvas LMS API — get_user_course_assignment_data","title":"Get user-in-a-course-level assignment data from the Canvas LMS API — get_user_course_assignment_data","text":"Retrieves user---course-level assignment data specific course student Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_assignment_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get user-in-a-course-level assignment data from the Canvas LMS API — get_user_course_assignment_data","text":"","code":"get_user_course_assignment_data(canvas, course_id, student_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_assignment_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get user-in-a-course-level assignment data from the Canvas LMS API — get_user_course_assignment_data","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve assignment data. student_id ID student retrieve assignment data.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_assignment_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get user-in-a-course-level assignment data from the Canvas LMS API — get_user_course_assignment_data","text":"list user---course-level assignment data retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_messaging_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Get user-in-a-course-level messaging data from the Canvas LMS API — get_user_course_messaging_data","title":"Get user-in-a-course-level messaging data from the Canvas LMS API — get_user_course_messaging_data","text":"Retrieves user---course-level messaging data specific course student Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_messaging_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get user-in-a-course-level messaging data from the Canvas LMS API — get_user_course_messaging_data","text":"","code":"get_user_course_messaging_data(canvas, course_id, student_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_messaging_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get user-in-a-course-level messaging data from the Canvas LMS API — get_user_course_messaging_data","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve messaging data. student_id ID student retrieve messaging data.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_messaging_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get user-in-a-course-level messaging data from the Canvas LMS API — get_user_course_messaging_data","text":"list user---course-level messaging data retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_participation_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Get user-in-a-course-level participation data from the Canvas LMS API — get_user_course_participation_data","title":"Get user-in-a-course-level participation data from the Canvas LMS API — get_user_course_participation_data","text":"Retrieves user---course-level participation data specific course student Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_participation_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get user-in-a-course-level participation data from the Canvas LMS API — get_user_course_participation_data","text":"","code":"get_user_course_participation_data(canvas, course_id, student_id)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_participation_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get user-in-a-course-level participation data from the Canvas LMS API — get_user_course_participation_data","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course retrieve participation data. student_id ID student retrieve participation data.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/get_user_course_participation_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get user-in-a-course-level participation data from the Canvas LMS API — get_user_course_participation_data","text":"list user---course-level participation data retrieved Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/pipe.html","id":null,"dir":"Reference","previous_headings":"","what":"Pipe operator — %>%","title":"Pipe operator — %>%","text":"See magrittr::%>% details.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/pipe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pipe operator — %>%","text":"","code":"lhs %>% rhs"},{"path":"https://vusaverse.github.io/vvcanvas/reference/pipe.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pipe operator — %>%","text":"lhs value magrittr placeholder. rhs function call using magrittr semantics.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/pipe.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pipe operator — %>%","text":"result calling rhs(lhs).","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/post_new_discussion.html","id":null,"dir":"Reference","previous_headings":"","what":"Post a New Discussion in Canvas LMS — post_new_discussion","title":"Post a New Discussion in Canvas LMS — post_new_discussion","text":"Creates new discussion topic specific course using Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/post_new_discussion.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Post a New Discussion in Canvas LMS — post_new_discussion","text":"","code":"post_new_discussion( canvas, course_id, discussion_title, discussion_message, discussion_is_announcement = FALSE )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/post_new_discussion.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Post a New Discussion in Canvas LMS — post_new_discussion","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course create discussion. discussion_title title discussion topic. discussion_message initial message content discussion topic. discussion_is_announcement (Optional) Whether discussion announcement. Defaults FALSE.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/post_new_discussion.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Post a New Discussion in Canvas LMS — post_new_discussion","text":"confirmation message discussion created.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/update_quiz.html","id":null,"dir":"Reference","previous_headings":"","what":"Modify an existing quiz. — update_quiz","title":"Modify an existing quiz. — update_quiz","text":"function modifies existing quiz specific course Canvas LMS API.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/update_quiz.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Modify an existing quiz. — update_quiz","text":"","code":"update_quiz(canvas, course_id, quiz_id, quiz_params)"},{"path":"https://vusaverse.github.io/vvcanvas/reference/update_quiz.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Modify an existing quiz. — update_quiz","text":"canvas object containing Canvas API key base URL, obtained canvas_authenticate function. course_id ID course containing quiz modified. quiz_id ID quiz modified. quiz_params named list quiz parameters update. list can include: title (string) quiz title. description (string) description quiz. quiz_type (string) type quiz. Allowed values: \"practice_quiz\", \"assignment\", \"graded_survey\", \"survey\". assignment_group_id (integer) assignment group id put assignment . Defaults top assignment group course. valid quiz graded. time_limit (integer) Time limit take quiz, minutes. Set NULL time limit. Defaults NULL. shuffle_answers (boolean) TRUE, quiz answers multiple choice questions randomized student. Defaults FALSE. hide_results (string) Dictates whether quiz results hidden students. Allowed values: \"always\", \"until_after_last_attempt\". Defaults NULL. show_correct_answers (boolean) FALSE, hides correct answers students quiz results viewed. Defaults TRUE. show_correct_answers_last_attempt (boolean) TRUE, hides correct answers students submit last attempt quiz. Defaults FALSE. show_correct_answers_at (DateTime) correct answers visible students date. hide_correct_answers_at (DateTime) correct answers stop visible date passed. allowed_attempts (integer) Number times student allowed take quiz. Set -1 unlimited attempts. Defaults 1. scoring_policy (string) Scoring policy quiz students can take multiple times. Allowed values: \"keep_highest\", \"keep_latest\". one_question_at_a_time (boolean) TRUE, shows quiz student one question time. Defaults FALSE. cant_go_back (boolean) TRUE, questions locked answering. Defaults FALSE. access_code (string) Restricts access quiz password. access code restriction, set NULL. ip_filter (string) Restricts access quiz computers specified IP range. due_at (DateTime) day/time quiz due. Accepts times ISO 8601 format, e.g., \"2011-10-21T18:48Z\". lock_at (DateTime) day/time quiz locked students. unlock_at (DateTime) day/time quiz unlocked students. published (boolean) Whether quiz published. one_time_results (boolean) Whether students prevented viewing quiz results past first time. Defaults FALSE. only_visible_to_overrides (boolean) Whether quiz visible overrides. Defaults FALSE. notify_of_update (boolean) TRUE, notifies users quiz changed. Defaults TRUE.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/update_quiz.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Modify an existing quiz. — update_quiz","text":"list representing updated quiz object.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/upload_qti_file_with_migration.html","id":null,"dir":"Reference","previous_headings":"","what":"Upload QTI File with Content Migration — upload_qti_file_with_migration","title":"Upload QTI File with Content Migration — upload_qti_file_with_migration","text":"function uploads QTI file specified course Canvas LMS initiates content migration. handles process creating migration, uploading file, checking migration status.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/upload_qti_file_with_migration.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Upload QTI File with Content Migration — upload_qti_file_with_migration","text":"","code":"upload_qti_file_with_migration( canvas, course_id, pre_attachment_name, pre_attachment_size, file_path, settings = list() )"},{"path":"https://vusaverse.github.io/vvcanvas/reference/upload_qti_file_with_migration.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Upload QTI File with Content Migration — upload_qti_file_with_migration","text":"canvas list containing 'api_key' 'base_url' authentication. course_id ID course QTI file uploaded. pre_attachment_name name file uploaded. required file upload process. pre_attachment_size size file uploaded bytes. required file upload process. file_path local file path QTI file needs uploaded. settings list additional settings content migration. can include options like question bank name overwrite settings.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/reference/upload_qti_file_with_migration.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Upload QTI File with Content Migration — upload_qti_file_with_migration","text":"confirmation message indicating QTI file uploaded content migration completed.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/news/index.html","id":"vvcanvas-004","dir":"Changelog","previous_headings":"","what":"vvcanvas 0.0.4","title":"vvcanvas 0.0.4","text":"CRAN release: 2024-04-29 Added methods sections. Added methods favorites. Updated authentication method. Updated vignette. Added method calendar events. Added method account roles.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/news/index.html","id":"vvcanvas-003","dir":"Changelog","previous_headings":"","what":"vvcanvas 0.0.3","title":"vvcanvas 0.0.3","text":"CRAN release: 2023-10-23 Added methods Analytics endpoints.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/news/index.html","id":"vvcanvas-002","dir":"Changelog","previous_headings":"","what":"vvcanvas 0.0.2","title":"vvcanvas 0.0.2","text":"CRAN release: 2023-07-17 Added NEWS.md file track changes package. Introduced number POST actions. Added vignette based use case user.","code":""},{"path":"https://vusaverse.github.io/vvcanvas/news/index.html","id":"vvcanvas-002-1","dir":"Changelog","previous_headings":"","what":"vvcanvas 0.0.2","title":"vvcanvas 0.0.2","text":"CRAN release: 2023-07-17 Published CRAN","code":""}] diff --git a/sitemap.xml b/sitemap.xml index 0592283..75b9f59 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -18,6 +18,8 @@ https://vusaverse.github.io/vvcanvas/reference/create_course_section.html https://vusaverse.github.io/vvcanvas/reference/create_folder.html https://vusaverse.github.io/vvcanvas/reference/create_group_category.html +https://vusaverse.github.io/vvcanvas/reference/create_module.html +https://vusaverse.github.io/vvcanvas/reference/create_module_item.html https://vusaverse.github.io/vvcanvas/reference/create_page.html https://vusaverse.github.io/vvcanvas/reference/delete_course_section.html https://vusaverse.github.io/vvcanvas/reference/download_course_file.html