align_archetypes_from_list {archetypal}

Align archetypes from a list either by the most frequent found or by using a given archetype

Description

Align archetypes from a list either by the most frequent or by using a given archetype.

Usage

align_archetypes_from_list(archs_list, given_arch = NULL,
  varnames = NULL, ndigits = 0, parallel = FALSE, 
  nworkers = NULL, verbose = TRUE)

Arguments

archs_list

The list of archetypes that must be aligned

given_arch

If it is not NULL, then given_arch will by used as guide for aligning other archetypes of list. Otherwise, a heuristic for finding the most frequent archetype will be used.

varnames

The character vector of variable names that must be used. If it is NULL, then the column names of first archetype will be used.

ndigits

The number of digits that will be used for truncation.

parallel

If it set to TRUE, then parallel processing will be applied.

nworkers

The number of logical processors that will be used for parallel computing (usually it is the double of available physical cores).

verbose

If it is set to TRUE, then details are printed out

Value

A list with members:

1. arch_guide, the archetype used as guide for aligning others

2. phrases_most, a table with all rounded phrases from archetypes. Frequencies are in decreasing order, so first row indicates the most frequent sequence, if exists. Otherwise we take randomly a case and proceed.

3. archs_aa_output, a data frame with rows all given archetypes

4. archs_aligned, the final list of aligned archetypes

References

This function is a modification of "align_arc" function from package "ParetoTI", see https://github.com/vitkl/ParetoTI and https://github.com/vitkl/ParetoTI/blob/master/R/align_arc.R

Examples

data("wd2") #2D demo 
df = wd2
# Define 4 archetypes found for it
dalist = list(c(2.172991,3.200754,5.384013,2.579770,4.860343,3.085111),
              c(5.430821,3.128493,2.043495,3.146342,4.781851,2.710885),
              c(5.430752,2.043403,3.128520,3.146252,2.710979,4.781880),
              c(2.043854,5.430890,3.127183,2.710522,3.146432,4.780432))
archslist = lapply(dalist, function(x){matrix(x,ncol=2)}) #not aligned
# Run aligner
yy = align_archetypes_from_list(archs_list = archslist,
                                given_arch = archslist[[1]])
yy$arch_guide
aligned_archs = yy$archs_aligned
aligned_archs #observe that they are comparable now