new_sscs: Create a new sscs object.

Description Usage Arguments Details Value Examples

View source: R/sscs.R

Description

Creates a new sscs S3 object based on data matrix X and variable groupings js.

Usage

1
  new_sscs(X, js)

Arguments

X

Numeric matrix where rows are observations and columns are variates.

js

Integer vector with length equal to the number of columns of X, identifying multi-variate groupings of X's columns.

Details

Currently only permits hard clustering; a soft clustering implementation will be made available in a future release.

Value

Returns a new sscs S3 object to be used with e.g. run(...).

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 
# combine measurements
X <- cbind(US_state_temperature, US_state_precipitation)

# describe how columns of X are grouped into
# multi-variate variables.
nstates <- ncol(US_state_temperature)
js      <- rep(1:nstates, 2)

# create a new sscs object to be used with e.g. run(sscs, ...)
sscs <- new_sscs(X, js)


## End(Not run)

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