makeScanoneThresholdObject: Make 'scanone' threshold object.

Description Usage Arguments Value

View source: R/util.R

Description

Make scanone threshold object.

Usage

1
2
makeScanoneThresholdObject(threshold, lodcolnames = "lod", alpha = NULL,
  fdr = NULL)

Arguments

threshold

LOD threshold value.

lodcolnames

Character vector of LOD column names to be used in the scanone threshold object.

alpha

Significance level (alpha) associated with the specified LOD threshold. (Incompatible with fdr.)

fdr

False-discovery rate associated with the specified LOD threshold. (Incompatible with alpha.)

Value

If alpha is specified, a summary.scanoneperm object is returned, with the given threshold at the specified alpha for each LOD column. If fdr is specified, a summary.scanonebins object is returned, with the given threshold at the specified fdr in the single LOD column for all phenotypes. In any case, because no permutations are used in generating the threshold, the returned object has attribute 'n.perm' containing the value 0.


gact/shmootl documentation built on Nov. 11, 2021, 6:23 p.m.