Learn R Programming

archetypes (version 2.0-2)

archetypes-class: Archetypes object constructor and methods.

Description

Archetypes object constructor and methods.

Usage

as.archetypes(archetypes, k, alphas, rss, iters, call, history, kappas, betas, zas,
    family, familyArgs, residuals, weights, reweights)
## S3 method for class 'archetypes':
fitted(object, ...)
## S3 method for class 'archetypes':
coef(object, type=c("alphas", "betas"), ...)
## S3 method for class 'archetypes':
residuals(object, ...)
## S3 method for class 'archetypes':
rss(object, type=c("scaled", "single", "global"), ...)
## S3 method for class 'archetypes':
weights(object, type=c("weights", "reweights"), ...)
## S3 method for class 'archetypes':
kappa(z, ...)
## S3 method for class 'archetypes':
nparameters(object, ...)

Arguments

archetypes
The archetypes; a $p \times m$ matrix, see atypes.
k
The number of archetypes;
alphas
The coefficients; a $n \times p$ matrix, see alphas.
rss
The residual sum of squares; see rss.
iters
The number of iterations to the convergence.
call
The call of the archetypes function.
history
If saveHistory set then an environment with the archetypes object for each execution step;
kappas
The kappas for each system of linear equations.
betas
The data coefficients; a $p \times n$ matrix.
zas
The temporary archetypes.
family
The archetypes family.
familyArgs
Additional arguments for family blocks.
residuals
The residuals.
weights
The data weights.
reweights
The data reweights.
object
An archetypes-related object.
...
Ignored.
type
Return alphas or betas.
z
An archetypes object.

Value

  • as.archetypes: A list with an element for each parameter and class attribute archetypes. fitted.archetypes: Matrix with approximated data. parameters,archetypes-method: Matrix with $k$ archetypes. coef.archetypes: Coefficient matrix. residuals.archetypes: Matrix with residuals. rss.archetypes: Residual sum of squares. weights.archetypes: Vector of weights. kappa.archetypes: A vector of kappas. nparameters.archetypes: Number of archetypes.

See Also

archetypes