#format wiki
#language en
#pragma section-numbers off
#acl IanRiley:read,write,delete,revert,admin All:read
#pragma supplementation-page on

<<TableOfContents>>
= RandomGroups =

== Background and rationale ==

For some teaching activities, it can be useful randomly allocate students (or other list items) to groups.

== Description ==

The !RandomGroups macro takes a list of items (e.g. student names) from an attached file (default `class.text`), and returns a table with the items allocated to groups of a specified size (between 2 and 6 per group).

If desired the headings for the table of groups and members can be set allowing the randomising and grouping of items for other purposes than class members.

== Usage ==
{{{
<<RandomGroup([class=]"filename"[,[size=]size][,[sort=]sort][,[head1=]head1][,[head2=]head2])>>

class=filename: optional, default "class.txt"

size=size: optional, default 2, minimum 1 and maximum 99

sort=sort: optional, default False, can be set to True with 1, True, T, Yes, or Y (not case sensitive)

head1=head1: optional, default "Group"

head2=heat2: optional, default "Members"

}}}

== Download & Release Notes ==
|| Download || Release Version || Moin Version || Release Notes ||
|| [[attachment:RandomGroups-1.0.py]] || 1.0 || 1.9.8 || ||
|| [[attachment:RandomGroups-1.1.py]] || 1.1 || 1.9.8 ||Forced coding input file ||
|| [[attachment:RandomGroups-1.2.py]] || 1.2 || 1.9.8 ||Allows the table headings to be changed ||

== Examples ==

{{{
<<RandomGroups(size=3, sort=T)>>
}}}

<<RandomGroups(size=3, sort=T)>>

Refresh the page to see another allocation. <<Action(refresh)>>

See an example usage in [[RandomGroups.py/Example1|StudentGroups|target="_blank"]].

By setting the headings to "Unit" and "Treatment" with a group size of one, this can be used to randomly allocate treatments to plots when designing a student experiment.

See an example usage in [[RandomGroups.py/Example2|RandomTreatments|target="_blank"]].

== Copyright ==

 . @copyright: 2017 Ian Riley <ian@riley.asia>

== License ==

GNU GPL, see COPYING for details.

== Known issues and limitations ==

 * None

-----

 Hits:: <<Hits>>