print.allele_diversity_test: Print the result of a allele diversity test (alpha or gamma)

Description Usage Arguments Details Value References See Also Examples

View source: R/diversityTests-allele_divtables.R

Description

Print an object of class allele_diversity_test, the result of alphaDiversityTest, alphaContrastTest and gammaContrastTest when given an argument of class allele_divtables.

Usage

1
2
3
## S3 method for class 'allele_diversity_test'
print(x, digits = getOption("digits"),
  include.loci = FALSE, ...)

Arguments

x

Object of class allele_diversity_test, returned by alphaDiversityTest, alphaContrastTest and gammaContrastTest when given an argument of class allele_divtables

digits

Number of significant digits to use when printing numeric values. Defaults to the value of the "digits" option.

include.loci

If TRUE, print test results for each individual locus. Defaults to FALSE.

Details

The result of the test printed is the summed effect across all loci; see Sork et al. (2015) for details. If include.loci is TRUE, then this is followed by the test result for each locus individually.

Value

x, returned invisibly

References

Sork, V. L., Smouse, P. E., Grivet, D. and Scofield, D. G. (In press) Impact of asymmetric male and female gamete dispersal on allelic diversity and spatial genetic structure in valley oak (Quercus lobata N\'ee). Evolutionary Ecology.

See Also

alphaDiversityTest, alphaContrastTest, gammaContrastTest

Examples

1
2
3
4
5
## library(readGenalex)  # already loaded as a prerequisite
data(Qagr_pericarp_genotypes)  # from readGenalex
gt <- createAlleleTables(Qagr_pericarp_genotypes)
alpha.test <- alphaDiversityTest(gt)
print(alpha.test)

douglasgscofield/dispersalDiversity documentation built on March 30, 2021, 9:50 a.m.