Learn R Programming

⚠️There's a newer version (1.3.1) of this package.Take me there.

Overview

archetypal is a package for performing Archetypal Analysis (AA) by using a properly modified version of PCHA algorithm.

Basic functions are:

  • archetypal() do AA
  • find_outmost_projected_convexhull_points Projected CH initial solution.
  • find_outmost_convexhull_points CH initial solution.
  • find_outmost_partitioned_convexhull_points() Partitioned CH initial solution.
  • find_furthestsum_points() Furthests Sum initial solution.
  • find_outmost_points() Outmost initial solution.
  • check_Bmatrix() check B matrix after run of AA.
  • find_optimal_kappas() search for the optimal number of archetypes

Install the archetypal package and then read vignette("archetypal", package = "archetypal").

Installation

# Install with dependencies:
install.packages("archetypal",dependencies=TRUE)

Usage

library(archetypal)

data("wd2")
df=wd2
aa=archetypal(df=df,kappas = 3,verbose = FALSE,rseed=9102,save_history = TRUE)

# Time for computing Projected Convex Hull was 0.01 secs 
# Next projected convex hull initial solution will be used... 
#           x        y
# 34 5.687791 3.481611
# 62 1.961799 2.793497
# 5  5.123878 2.745874
# 
# archs=aa$BY
# archs
# x        y
# [1,] 5.430757 3.146258
# [2,] 2.043435 2.710947
# [3,] 3.128401 4.781751
# aa[c("SSE","varexpl","iterations","time" )]
# $SSE
# [1] 1.717538
# 
# $varexpl
# [1] 0.9993186
# 
# $iterations
# [1] 63
# 
# $time
# [1] 8.1
# cbind(names(aa))
# [,1]             
# [1,] "BY"             
# [2,] "A"              
# [3,] "B"              
# [4,] "SSE"            
# [5,] "varexpl"        
# [6,] "initialsolution"
# [7,] "freqstable"     
# [8,] "iterations"     
# [9,] "time"           
# [10,] "converges"      
# [11,] "nAup"           
# [12,] "nAdown"         
# [13,] "nBup"           
# [14,] "nBdown"         
# [15,] "run_results"   

Contact

Please send comments, suggestions or bug breports to dchristop$econ.uoa.gr

Copy Link

Version

Install

install.packages('archetypal')

Monthly Downloads

277

Version

1.0.0

License

GPL (>= 2)

Maintainer

Demetris Christopoulos

Last Published

June 13th, 2019

Functions in archetypal (1.0.0)

find_outmost_points

Function which finds the outmost points in order to be used as initial solution in archetypal analysis
align_archetypes_from_list

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

Function which checks B matrix of Archetypal Analysis Y ~ A B Y in order to find the used rows for creating each archetype and the relevant used weights.
find_optimal_kappas

Function for finding the optimal number of archetypes
FurthestSum

Application of FurthestSum Algorithm in Order to Find an Intial Solution for Archetypal Analyis
find_furthestsum_points

Function which finds the furthest sum points in order to be used as initial solution in archetypal analysis
find_outmost_convexhull_points

Function which finds the outmost convex hull points in order to be used as initial solution in archetypal analysis
find_outmost_partitioned_convexhull_points

Function which finds the outmost convex hull points after making np samples and findix convex hull for each of them. To be used as initial solution in archetypal analysis.
archetypal

archetypal: Finds the archetypal analysis of a data frame by using a modified version of PCHA algorithm
archetypal-package

Finds the Archetypal Analysis of a Data Frame
find_outmost_projected_convexhull_points

Function which finds the outmost projected convex hull points in order to be used as initial solution in archetypal analysis
wd2

2D data set for demonstration purposes
wd3

3D data set for demonstration purposes