allCommonDistinctive: allCommonDistinctive: creates all common and distinctive...

Description Usage Arguments Value Examples

View source: R/allCommonDistinctiveStructures.R

Description

A function that generates all common and distinctive structures given the number of variables per block and the number of components

Usage

1
2
3
4
5
6
allCommonDistinctive(
  vars,
  ncomp,
  allPermutations = TRUE,
  filterZeroSegments = TRUE
)

Arguments

vars

A vector with integers indicating the number of variables per data block. For example, c(10, 20, 5), the first 10 variables belong the first block, the next 20 variables belong to the second block, the next 5 variables belong to the third block

ncomp

The number of components that are of interest

allPermutations

A boolean with default TRUE. If set to TRUE, all permutations of common and distinctive will be taken into account (a certain component can occur in all positions). If set to FALSE all permutations will not be taken into account i.e. a certain component can only occur once. If the intent is to use multiple starts use FALSE else use TRUE

filterZeroSegments

A boolean with default TRUE. If set to TRUE components where all blocks are set to zero are not included.

Value

A list with all common and distinctive structures

Examples

1
2
3
allCommonDistinctive(vars = c(10, 5, 5), ncomp = 3, allPermutations = TRUE, filterZeroSegments = TRUE)
allCommonDistinctive(vars = c(10, 5, 5), ncomp = 3, allPermutations = FALSE, filterZeroSegments = FALSE)
 

trbKnl/sparseWeightBasedPCA documentation built on July 22, 2020, 10:29 p.m.