results {SNPhood} | R Documentation

## Get results of various analyses performed with a `SNPhood` object.

### Description

Return the results of a particular analyis that is stored in the `SNPhood` object.

### Usage

    results(SNPhood.o, type, elements = NULL)

### Arguments

`SNPhood.o` | Object of class `SNPhood`
`type` | Character(1). Name of analyses one wants to retrieve the results for. Currently supported are "allelicBias", "clustering", "genotype" and "samplesCorrelation".
`elements` | Character. Default NULL. Which elements of the resulting list structure should be returned? If set to NULL, all elements will be returned. Otherwise, if names are provided, only the requested subset elements will be returned. If type equals "allelicBias", valid values are "pValue", "confIntervalMin", "confIntervalMax", "fractionEstimate", "background", "FDR_results", and "parameters". If type equals "clustering", valid values are the defined read groups in the object. If type equals "genotype", valid values are "strongGenotypes", "weakGenotypes", and "invariantGenotypes". If type equals "samplesCorrelation", valid values are "corTable", and "transl".

### Value

A list with the results of the requested analysis and elements within.

### Examples

    data(SNPhood.o, package="SNPhood")
    head(results(SNPhood.o, type="allelicBias", elements = "parameters"))
    head(results(SNPhood.o, type="allelicBias"))

[Package SNPhood version 1.24.0 Index]