correlate: Generic Function for Correlation Calculations

correlateR Documentation

Generic Function for Correlation Calculations

Description

[Experimental]

New generic function to calculate correlations for one or two objects.

Usage

correlate(object, ...)

Arguments

object

input of which the class will be used to decide the method.

...

additional arguments.

Value

Corresponding object that contains the correlation results.

See Also

pca_cor_samplevar and calc_cor which are the methods included for this generic function.

Examples

sample_cors <- correlate(hermes_data)
autoplot(sample_cors)

pca_sample_var_cors <- correlate(calc_pca(hermes_data), hermes_data)
autoplot(pca_sample_var_cors)

insightsengineering/hermes documentation built on Sept. 19, 2024, 9:06 p.m.