get_lod_peaks_by_covar: Get the LOD peaks for a dataset.

View source: R/get-lod-peaks-by-covar.R

get_lod_peaks_by_covarR Documentation

Get the LOD peaks for a dataset.

Description

Used internally to the package.

Usage

get_lod_peaks_by_covar(ds, intcovar = NULL)

Arguments

ds

The dataset object to get the LOD peaks for.

intcovar

NULL for 'additive' or a value representing the interactive covariate.

Details

By default, this will get all LOD peaks stored in the 'dataset$lod_peaks' 'list'. If 'intcovar' is specified, only the peaks for that are returned.

Value

A a 'tibble' with the following columns depending upon 'dataset$datatype':

  • mRNA - 'marker,chr,pos,gene_id,symbol,gene_chrom,middle,lod'

  • protein - 'marker,chr,pos,protein_id,gene_id,symbol,gene_chrom,middle,lod'

  • phenotype - 'marker,chr,pos,data_name,short_name,description,lod'

If the allele effects are stored, values 'A-H' will also be included.


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