degreesOfFreedom-methods {cpvSNP} | R Documentation

## ~~ Methods for Function `degreesOfFreedom` ~~

### Description

This function returns the degrees of freedom used to calculate p-values from the corresponding `GeneSet` or a list of degrees of freedom for a `GeneSetCollection`.

### Usage

    degreesOfFreedom(object)

### Arguments

`object` | An object of type `GeneSetResult`, `VEGASResult`, `GLOSSIResult`, `GeneSetResultCollection`, `VEGASResultCollection`, or `GLOSSIResultCollection`

### Methods

Defined methods include:

`signature(object = "GeneSetResult")`

  Returns the degrees of freedom for a `GeneSetResult` object

`signature(object = "VEGASResult")`

  Returns the degrees of freedom for a `VEGASResult` object

`signature(object = "GLOSSIResult")`

  Returns the degrees of freedom for a `GLOSSIResult` object

`signature(object = "GeneSetResultCollection")`

  Returns a list of degrees of freedom for a `GeneSetResultCollection` objects (1 for each set)

`signature(object = "VEGASResultCollection")`

  Returns a list of degrees of freedom for a `VEGASResultCollection` objects (1 for each set)

`signature(object = "GLOSSIResultCollection")`

  Returns a list of degrees of freedom for a `GLOSSIResultCollection` objects (1 for each set)

### Value

Returns an integer or a list of integers indicating the degrees of freedom in the corresponding object.

### Author(s)

Caitlin McHugh

### See Also

`VEGASResult`-class, `pValue`

### Examples

    	## Not run:
    	degreesOfFreedom( vegas(geneSet, assoc_table, ldMatrix) )

    ## End(Not run)

[Package cpvSNP version 1.22.0 Index]