itrax_correlation: Calculate a correlation matrix for Itrax result data

View source: R/itrax_correlation.r

itrax_correlationR Documentation

Calculate a correlation matrix for Itrax result data

Description

Calculates a correlation matrix for Itrax data results including normalisation and visualisation

Usage

itrax_correlation(
  dataframe,
  elementsonly = TRUE,
  zeros = "addone",
  transform = TRUE,
  plot = FALSE
)

Arguments

dataframe

pass the name of a dataframe parsed using "itrax_import()" or "itrax_join()"

elementsonly

if TRUE, only chemical elements are included. If FALSE, the data is passed unfiltered, otherwise a character vector of desired variable names can be supplied

zeros

if "addone", adds one to all values. If "limit", replaces zero values with 0.001. Otherwise a function can be supplied to remove zero values.

transform

binary operator that if TRUE will center-log-transform the data, if FALSE will leave the data untransformed. Otherwise, a function can be supplied to transform the data.

plot

set to true if a biplot is required as a side-effect

Value

a correlation matrix object

Examples

itrax_correlation(CD166_19_S1$xrf, plot = TRUE)


itraxR documentation built on July 26, 2023, 5:48 p.m.