soc.ca (version 0.8.0)

contribution: Summaries of contribution values

Description

Different forms of contribution summaries for soc.ca objects. Results are presented according to the specified mode

Usage

contribution(
  object,
  dim = 1,
  all = FALSE,
  indices = FALSE,
  mode = "sort",
  matrix.output = FALSE
)

Arguments

object

a soc.ca object

dim

the included dimensions

all

If TRUE returns all modalities instead of just those that contribute above average

indices

If TRUE; returns a vector with the row indices of the modalities or individuals

mode

indicates which form of output. Possible values: "sort", "mod", "ind", "variable". If the mode is "variable", dim can be a sequence of dimensions: 1:5

matrix.output

if TRUE; returns output as a matrix instead of as printed output.

Value

Each mode prints different results:

"mod"

Ranks all modalities according to their contribution

"sort"

Ranks all modalities according to their contribution and then sorts them according to their coordinates

"ind"

Ranks all individuals according to their contribution

"variable"

Sorts all modalities according to their variable and sums the contributions per variable

The values reported:

Ctr

Contribution values in percentage. Contribution values for individuals are reported in permille

Coord

Principal coordinates

Cor

The correlation with the dimension

See Also

map.ctr

Examples

# NOT RUN {
example(soc.ca)
contribution(result)
contribution(result, 2)
contribution(result, dim = 3, all = TRUE)
contribution(result, indices = TRUE)
contribution(result, 1:2, mode = "variable")
# }