binLODValues: Bin LOD values of 'scanone' object.

Description Usage Arguments Value

View source: R/binLODValues.R

Description

Bin LOD values of scanone object.

Usage

1
binLODValues(x, lodcolumns = NULL)

Arguments

x

A scanone object or equivalent data.frame in which the data columns contain LOD score values.

lodcolumns

In a scanone or equivalent object, this parameter indicates which LOD columns to consider. In other objects with LOD-column-associated elements, this parameter indicates which of those LOD-column-associated elements to consider. The specified LOD columns must be a character vector of LOD column names, a logical vector with length equal to the number of LOD columns, or a numeric vector of indices with respect to the set of LOD columns. If no LOD columns are specified, all are used.

Value

A scanonebins array of LOD bin counts, with a single row, each column corresponding to a bin spanning an interval of LOD values, and each slice corresponding to a LOD column. Each column name indicates the half-open interval that defines the given bin (e.g. 'LOD[1.1,1.2)' for a bin that contains the number of loci with LOD scores greater than or equal to 1.1 and less than 1.2).


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