initiateAnalysis: Initiate analysis
In kueckelj/confuns: Convenience Functions

initiateAnalysis

R Documentation

Initiate analysis

Description

Sets up an object of class AnalysisAspect.

Usage

initiateAnalysis(
  data,
  key_name,
  key_prefix = NULL,
  meta_names = character(0),
  cluster_with = "data",
  lgl_to_group = TRUE,
  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.
`verbose`
`analysis_aspect`	The actual analysis aspect. Use `validAnalysisAspects()` to obtain all valid input options.