statVectorCloud: Computes the statistic 'stat' (default is 'base::mean')...

View source: R/expression_funks.R

statVectorCloudR Documentation

Computes the statistic stat (default is base::mean) vector of the cloud of vectors. Also infers the deviance in terms of deviance.funk (default is base::sd) of each axis of the vector space.

Description

Computes the statistic stat (default is base::mean) vector of the cloud of vectors. Also infers the deviance in terms of deviance.funk (default is base::sd) of each axis of the vector space.

Usage

statVectorCloud(vecs.df,
  stat = getOption("GeneFamilies.vector.cloud.stat", mean),
  deviance.funk = getOption("GeneFamilies.vector.cloud.deviance", sd))

Arguments

vecs.df

A matrix of data.frame of row vectors of the same vector space

stat

A function used to infer the vector representing the argument cloud. The function is applied on each column seperately in order to infer the resulting vector's components. Default is getOption('GeneFamilies.vector.cloud.stat', mean).

deviance.funk

Function applied on each column of the cloud vecs.df in order to infer the cloud's spread around it's representing vector. Default is getOption('GeneFamilies.vector.cloud.deviance', sd).

Value

A list with three named entries: stat.vec the vector representing the cloud, deviance.vec the vector representing the spread around stat.vec, and the vector orthogonal on the vector space diagonal pointing to the stat.vec.


asishallab/GeneFamilies documentation built on May 22, 2023, 11:30 a.m.