init: Initialize an sscs object.

Description Usage Arguments Value

View source: R/sscs.R

Description

Specify the number of clusters and initialize cluster membership assignments for a given sscs object.

Usage

1
  init(sscs, nclusters=2, balanced=FALSE)

Arguments

sscs

Object of class 'sscs' created by new_sscs(...).

nclusters

Integer number of clusters >= 1.

balanced

Boolean determining whether or not to bias the initial cluster memberships to be evenly distributed across clusters. Set to TRUE only if performance is an issue, otherwise use the default (FALSE) to keep the initial memberships unbiased.

Value

Returns an initialized sscs S3 object that can be iteratively updated using update_assignment(...).


crtwomey/sscs documentation built on Dec. 25, 2019, 8:03 a.m.