initiateAnalysisAspect: Initiate analysis

In kueckelj/confuns: Convenience Functions

Initiate analysis

Description

Sets up an object of class AnalysisAspect.

Usage

initiateAnalysisAspect(
  data,
  key_name,
  key_prefix = NULL,
  meta_names = character(0),
  lgl_to_group = TRUE,
  analysis_aspect = "AnalysisAspect",
  verbose = TRUE
)

initiateDimRed(
  data,
  key_name,
  key_prefix = NULL,
  lgl_to_group = TRUE,
  meta_names = character(0),
  verbose = TRUE
)

initiateClustering(
  data,
  key_name,
  key_prefix = NULL,
  lgl_to_group = TRUE,
  meta_names = character(0),
  verbose = TRUE
)

initiateCorrelation(
  data,
  key_name,
  key_prefix = "ID",
  lgl_to_group = TRUE,
  meta_names = character(0),
  verbose = TRUE
)

Arguments

data	Data.frame containing the data to be analyzed.
key_name	The key variable. If NULL, the key variable is created either by using the rownames and - if rownames are invalid - by combining input for argument key_prefix with the rownumbers.
key_prefix	Character value. The prefix for the artificial key variable.
meta_names	Names of the data.frame of data that are supposed to be treated as meta data. Meta data is not integrated in any form of analysis.
analysis_aspect	The actual analysis aspect. Use validAnalysisAspects() to obtain all valid input options.
verbose

Value

An object of class specified in analysis_aspect.

kueckelj/confuns documentation built on July 4, 2024, 4:53 p.m.