show.saliency {affinitymatrix}R Documentation

Print summary of saliency analysis

Description

This function prints the results from the saliency analysis in LaTeX style. The function returns a list of two elements: U.table contains the first ncol_x vectors of loadings that map men's Kx observed traits into the first ncol_x matching factors; V.table contains the first ncol_y vectors of loadings that map women's Ky observed traits into the first ncol_y matching factors. In both tables, the last line reports the normalized singular values of the affinity matrix in descending order.

Usage

show.saliency(
  res,
  ncol_x = Kx,
  ncol_y = Ky,
  labels_x = paste0("Trait ", 1:Kx),
  labels_y = paste0("Trait ", 1:Ky),
  pr = 0.05
)

Arguments

res

A list corresponding to the output of estimate.affinity.matrix, estimate.affinity.matrix.lowrank or estimate.affinity.matrix.unipartite.

ncol_x

An integer indicating the number of singular vector to print for men. The function prints the first ncol_x singular vectors. Defaults to ncol(U).

ncol_y

An integer indicating the number of singular vector to print for women. The function prints the first ncol_y singular vectors. Defaults to ncol(V).

labels_x

A vector of strings indicating the names of men's matching variables. Defaults to "Trait k" for every k matching variable.

labels_y

A vector of strings indicating the names of women's matching variables. Defaults to "Trait k" for every k matching variable.

pr

A probability indicating the two-tailed significance level required for an estimated parameter to be printed in boldface. Defaults to 0.05 and can be set to 0 to avoid printing any estimate in boldface.

Value

The function returns a long string in LaTeX style that can be processed in the standard LaTeX tabular environment in order to display the estimates of the vectors of loadings for the first ncol_x men's matching factors and the first ncol_y women's matching factors.


[Package affinitymatrix version 0.1.0 Index]