calc_correlation: Get the correlation.

View source: R/calc-correlation.R

calc_correlationR Documentation

Get the correlation.

Description

Perform a correlation analysis on an 'id' for a 'dataset'. By default, the correlation will be against the same dataset, but a different dataset can be specified with 'dataset_correlate'.

Usage

calc_correlation(
  dataset,
  id,
  dataset_correlate = NULL,
  intcovar = NULL,
  use_qr = TRUE,
  backfill_NA = TRUE
)

Arguments

dataset

The dataset object

id

The unique id in the dataset.

dataset_correlate

The dataset to correlate against, dataset if INVALID or NULL.

intcovar

The interactive covariate.

use_qr

'TRUE' to use qr decomposition.

backfill_NA

'TRUE' if we need to impute, we backfill the NAs.

Value

A 'tibble' with the correlation and annotations.


churchill-lab/qtl2api documentation built on April 17, 2025, 3:27 a.m.