-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
139 lines (98 loc) · 6.19 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# hwep <img src="man/figures/logo.png" align="right" height="139" />
<!-- badges: start -->
[](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2132247)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://cran.r-project.org/package=hwep)
[](https://CRAN.R-project.org/package=hwep)
[](https://github.com/dcgerard/hwep/actions)
[](https://app.codecov.io/gh/dcgerard/hwep)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
<!-- badges: end -->
Inference concerning equilibrium and random mating in autopolyploids. Methods are available to test for equilibrium and random mating at any even ploidy level (>2) in the presence of double reduction at biallelic loci. For autopolyploid populations in equilibrium, methods are available to estimate the degree of double reduction. We also provide functions to calculate genotype frequencies at equilibrium, or after one or several rounds of random mating, given rates of double reduction. For details of these methods, see Gerard (2023a) \<[doi:10.1111/biom.13722](https://doi.org/10.1111/biom.13722)\> and Gerard (2023b) \<[doi:10.1111/1755-0998.13856](https://doi.org/10.1111/1755-0998.13856)\>.
The main functions for inference are:
- `hwefit()`: Fit either `hwelike()`,`rmlike()`, `hweustat()`,
`hwenodr()`, or `hweboot()` across many loci. Parallelization is supported through the
[future](https://cran.r-project.org/package=future) package.
- `hwelike()`: Likelihood inference for equilibrium.
This function estimates the rate of double reduction given
equilibrium, and tests for at most small deviations from
equilibrium.
- `rmlike()`: Likelihood inference for random mating in polyploids.
This function tests for random mating and estimates gametic frequencies
given random mating. This function does not assume a model for meiosis.
- `hweustat()`: U-statistic approach for equilibrium and double reduction.
This function tests for equilibrium given double reduction rates and
estimates these rates given equilibrium.
- `hwenodr()`: Implements a likelihood ratio test that tests for Hardy-Weinberg
equilibrium in autopolyploids given no double reduction.
- `hweboot()`: Implements a bootstrap approach to test for equilibrium
which is more appropriate for small samples and uncertain genotypes.
- `rmbayes()`: Implements a Bayesian test for random mating in autopolyploids
for any ploidy level.
- `rmbayesgl()`: Bayesian test for random mating, accounting for genotype
uncertainty using genotype likelihoods.
- `menbayesgl()`: Bayesian test for Mendelian segregation frequencies in
S1 or F1 populations using genotype likelihoods.
Functions are provided for calculating genotype frequencies for individuals and gametes:
- `gsegmat()`: Produces the segregation probabilities for gamete dosages given parental dosages and the double reduction rate.
- `gsegmat_symb()`: Provides a symbolic representation of the output of `gsegmat()`.
- `zsegarray()`: Obtains offspring genotype probabilities given parental probabilities, the ploidy of the species, and the overdispersion parameter, for all possible parental genotypes.
- `freqnext()`: Updates the genotype frequencies after one generation of random mating.
- `hwefreq()`: Calculate genotype frequencies at equilibrium.
The bounds on the double reduction rate under the complete equational segregation model are provided by `drbounds()`.
Functions for evaluating the uniformity of p-values are provided in `ts_bands()` and `qqpvalue()`.
## Installation
You can install the released version of hwep from [CRAN](https://cran.r-project.org/package=hwep) with:
```{r, eval = FALSE}
install.packages("hwep")
```
You can install the development version from [GitHub](https://github.com/dcgerard/hwep) with:
```{r, eval = FALSE}
# install.packages("devtools")
devtools::install_github("dcgerard/hwep")
```
## Citation
To cite hwep in publications use:
> Gerard D (2023). "Double reduction estimation and equilibrium tests in natural autopolyploid populations." _Biometrics_, *79*(3), 2143--2156. [doi:10.1111/biom.13722](https://doi.org/10.1111/biom.13722).
A BibTeX entry for LaTeX users is
``` tex
@Article{,
title = {Double reduction estimation and equilibrium tests in natural autopolyploid populations},
author = {David Gerard},
journal = {Biometrics},
year = {2023},
doi = {10.1111/biom.13722},
volume = {79},
number = {3},
pages = {2143--2156},
}
```
If you use `rmbayes()`, `rmbayesgl()`, or `menbayeslg()`, then please also cite
> Gerard D (2023). "Bayesian tests for random mating in polyploids." _Molecular Ecology Resources_, *In press*. [doi:10.1111/1755-0998.13856](https://doi.org/10.1111/1755-0998.13856).
A BibTeX entry for LaTeX users is
``` tex
@Article{,
title = {Bayesian Tests for Random Mating in Polyploids},
author = {David Gerard},
journal = {Molecular Ecology Resources},
year = {2023},
doi = {10.1111/1755-0998.13856},
volume = {In press},
}
```
## Acknowledgments
This material is based upon work supported by the National Science Foundation under Grant No. [2132247](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2132247). The opinions, findings, and conclusions or recommendations expressed are those of the author and do not necessarily reflect the views of the National Science Foundation.
## Code of Conduct
Please note that the hwep project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.