tucker_ica_helper {scITD}

Helper function for running the decomposition. Use the run_tucker_ica() wrapper function instead.

Description

Helper function for running the decomposition. Use the run_tucker_ica() wrapper function instead.

Usage

tucker_ica_helper(
  tensor_data,
  ranks,
  tucker_type,
  rotation_type,
  projection_container = NULL
)

Arguments

tensor_data

list The tensor data including donor, gene, and cell type labels as well as the tensor array itself

ranks

numeric The number of donor and gene factors respectively, to decompose to using Tucker decomposition.

tucker_type

character The 'regular' type is the only one currently implemented

rotation_type

character Set to 'hybrid' to optimize loadings via our hybrid method (see paper for details). Set to 'ica_dsc' to perform ICA rotation on resulting donor factor matrix. Set to 'ica_lds' to optimize loadings by the ICA rotation.

projection_container

environment A project container to store projection data in. Currently only implemented for 'hybrid' and 'ica_dsc' rotations. (default=NULL)

Value

The list of results for tucker decomposition with donor scores matrix in first element and loadings matrix in second element.