create_course_assignment: Create a course assignment

In daranzolin/rcanvas: R Client for Canvas API

Create a course assignment

Description

Create a course assignment

Usage

create_course_assignment(
  course_id,
  name,
  position = NULL,
  submission_types = NULL,
  allowed_extensions = NULL,
  turnitin_enabled = NULL,
  vericite_enabled = NULL,
  turnitin_settings = NULL,
  integration_data = NULL,
  integration_id = NULL,
  peer_reviews = NULL,
  automatic_peer_reviews = NULL,
  notify_of_update = NULL,
  group_category_id = NULL,
  grade_group_students_individually = NULL,
  external_tool_tag_attributes = NULL,
  points_possible = NULL,
  grading_type = NULL,
  due_at = NULL,
  lock_at = NULL,
  unlock_at = NULL,
  description = NULL,
  assignment_group_id = NULL,
  muted = NULL,
  assignment_overrides = NULL,
  only_visible_to_overrides = NULL,
  published = NULL,
  grading_standard_id = NULL,
  omit_from_final_grade = NULL,
  quiz_lti = NULL
)

Arguments

course_id	a valid course id
name	the assignment name (only parameter required)
position	integer - The position of this assignment in the group when displaying assignment lists.
submission_types	string - List of supported submission types for the assignment. Unless the assignment is allowing online submissions, the array should only have one element. Options: online_quiz, none, on_paper, discussion_topic, external_tool, online_upload, online_text_entry, online_url, media_recording
allowed_extensions	Allowed extensions if submission_types includes “online_upload”. E.g. "docx", "png".
turnitin_enabled	boolean - Only applies when the Turnitin plugin is enabled for a course and the submission_types array includes “online_upload”. Toggles Turnitin submissions for the assignment. Will be ignored if Turnitin is not available for the course.
vericite_enabled	boolean - Only applies when the VeriCite plugin is enabled for a course and the submission_types array includes “online_upload”. Toggles VeriCite submissions for the assignment. Will be ignored if VeriCite is not available for the course.
turnitin_settings	string - Settings to send along to turnitin. See Assignment object definition for format.
integration_data	string - Data used for SIS integrations. Requires admin-level token with the “Manage SIS” permission. JSON string required.
integration_id	string - Unique ID from third party integrations
peer_reviews	boolean - If submission_types does not include external_tool,discussion_topic, online_quiz, or on_paper, determines whether or not peer reviews will be turned on for the assignment.
automatic_peer_reviews	boolean - Whether peer reviews will be assigned automatically by Canvas or if teachers must manually assign peer reviews. Does not apply if peer reviews are not enabled.
notify_of_update	boolean - If true, Canvas will send a notification to students in the class notifying them that the content has changed.
group_category_id	integer - If present, the assignment will become a group assignment assigned to the group.
grade_group_students_individually	boolean - If this is a group assignment, teachers have the options to grade students individually. If false, Canvas will apply the assignment's score to each member of the group. If true, the teacher can manually assign scores to each member of the group.
external_tool_tag_attributes	string - Hash of external tool parameters if submission_types is external_tool. See Assignment object definition for format.
points_possible	number - The maximum points possible on the assignment.
grading_type	string - The strategy used for grading the assignment. The assignment defaults to “points” if this field is omitted. Options: pass_fail, percent, letter_grade, gpa_scale, points
due_at	datetime - The day/time the assignment is due. Must be between the lock dates if there are lock dates. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
lock_at	datetime - The day/time the assignment is locked after. Must be after the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
unlock_at	datetime - The day/time the assignment is unlocked. Must be before the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
description	string - The assignment's description, supports HTML.
assignment_group_id	number - The assignment group id to put the assignment in. Defaults to the top assignment group in the course.
muted	boolean - Whether this assignment is muted. A muted assignment does not send change notifications and hides grades from students. Defaults to false.
assignment_overrides	List of overrides for the assignment.
only_visible_to_overrides	boolean - Whether this assignment is only visible to overrides (Only useful if 'differentiated assignments' account setting is on)
published	boolean - Whether this assignment is published. (Only useful if 'draft state' account setting is on) Unpublished assignments are not visible to students.
grading_standard_id	integer - The grading standard id to set for the course. If no value is provided for this argument the current grading_standard will be un-set from this course. This will update the grading_type for the course to letter_grade' unless it is already 'gpa_scale'.
omit_from_final_grade	boolean - Whether this assignment is counted towards a student's final grade.
quiz_lti	boolean - Whether this assignment should use the Quizzes 2 LTI tool. Sets the submission type to 'external_tool' and configures the external tool attributes to use the Quizzes 2 LTI tool configured for this course. Has no effect if no Quizzes 2 LTI tool is configured.

Value

invisible

Examples

create_course_assignment(course_id = 432432, name = "Challenging Assignment")
create_course_assignment(course_id = 3432432, name = "R Packages, Review", peer_reviews = TRUE, points_possible = 100, omit_from_final_grade = TRUE)

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