create_group_category: Create a group category

View source: R/groups.R

create_group_categoryR Documentation

Create a group category

Description

Does not work yet. Returns 422. Unclear how to fix.

Usage

create_group_category(
  context_id,
  context_type = "courses",
  cat_name,
  self_signup = NULL,
  auto_leader = NULL,
  group_limit = NULL,
  create_group_count = NULL
)

Arguments

context_id

Context id

context_type

Context type

cat_name

Name of the group category. Required.

self_signup

Allow students to sign up for a group themselves (Course Only). valid values are: “enabled”, allows students to self sign up for any group in course; “restricted” allows students to self sign up only for groups in the same section null disallows self sign up

auto_leader

Assigns group leaders automatically when generating and allocating students to groups. Valid values are: “first” the first student to be allocated to a group is the leader; “random” a random student from all members is chosen as the leader

group_limit

Limit the maximum number of users in each group (Course Only). Requires self signup.

create_group_count

Create this number of groups (Course Only).

Value

invisible

Examples

create_group_category(1350207, "courses", "FinalProjectGroup",
"enabled", "first", 3, 48)

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