MangroveSample: The MangroveSample class

Description Usage Arguments Details Value See Also Examples

Description

Functions for manipulating MangroveSample objects

Usage

1
2
3
4
5
6
## S3 method for class 'MangroveSample'
print(x,...)
## S3 method for class 'MangroveSample'
summary(object, ...)
## S3 method for class 'MangroveSample'
plot(x,...)

Arguments

x

A MangroveSample object.

object

A MangroveSample object.

...

Further arguments to be passed on to downstream methods.

Details

MangroveSample objects are produced from a MangroveTree object via a call to tree$getPrevs. They contain samples from the posterior distribution of number of affecteds in a family conditional on that family's genotypes.

The print method writes all the samples to screen. You can plot the distribution of number of affecteds using the plot method (which calls plotSampledPrev), and perform a significance test for whether the observed number of affecteds is greater than would be expected using the summary method.

You can see a detailed example of how these methods are applied by calling vignette("Mangrove")

Value

None of the methods return anything.

See Also

MangroveTree to generate MangroveSample objects. plotSampledPrev for more on plotting expected distributions.

Examples

1
2
3
4
5
6
7
8

Mangrove documentation built on May 29, 2017, 11:54 a.m.