snpEnrichment (version 1.2-3)

summary-methods: Summary method (S4)

Description

summary is a generic function used to produce result summaries of the results of various model fitting functions. The function invokes particular methods which depend on the class of the first argument.

Usage

## S3 method for class 'Enrichment':
summary(object, extended = TRUE, complete = TRUE) 
## S3 method for class 'Chromosome':
summary(object, extended = TRUE)

Arguments

object

[Enrichment or Chromosome]: an object of class Enrichment or Chromosome.

extended

[logical]: extended=TRUE (default) to add xSNP.

complete

[logical]: complete=TRUE (default) to add chromosomes results.

Value

• Return a vector (extended=FALSE) or a list of two vector (extended=TRUE) for classes Enrichment and Chromosome (complete=TRUE). If complete=TRUE, return a data.frame (extended=FALSE) or a list of two data.frame (extended=TRUE) for class Enrichment.

See Also

Overview : snpEnrichment-package Classes : Enrichment, Chromosome, EnrichSNP Methods : plot, reSample, excludeSNP, compareEnrichment, enrichment, is.enrichment, chromosome, is.chromosome Functions : initFiles, writeLD, readEnrichment

Examples

data(toyEnrichmentM1)
summary(toyEnrichmentM1)