assign_group_membership: Assign group membership to nodes

Description Usage Arguments Value Examples

View source: R/assign_group_membership.R

Description

Assign group membership to nodes

Usage

1
2
assign_group_membership(N, K, place_randomly = FALSE,
  ensure_all_groups_seen = TRUE)

Arguments

N

Total number of nodes

K

Total number of groups or clusters

place_randomly

Do we want to randomly sample group membership for nodes? Defaults to FALSE so all groups are evenly (or as close to as possible) represented.

ensure_all_groups_seen

If place_randomly = TRUE, do we make sure that at least one node is placed in every group?

Value

An array of memberships of length N made up of K groups as encoded with integers

Examples

1
2
3
assign_group_membership(10, 3)
assign_group_membership(10, 4, place_randomly = TRUE)
assign_group_membership(10, 4, place_randomly = TRUE, ensure_all_groups_seen = FALSE)

tbilab/BiSBMSim documentation built on Nov. 5, 2019, 10:01 a.m.