|
4 | 4 | # ACEsimFit |
5 | 5 |
|
6 | 6 | <!-- badges: start --> |
| 7 | + |
| 8 | +[](https://www.repostatus.org/#active) |
| 11 | +[](https://cran.r-project.org/package=discord) |
| 13 | +[](https://cran.r-project.org/package=ACEsimFit)</br> |
| 15 | +[](https://github.com/R-Computing-Lab/ACEsimFit/actions/workflows/R-CMD-check.yaml) |
| 16 | +[](https://app.codecov.io/gh/R-Computing-Lab/ACEsimFit) |
| 18 | + |
| 19 | + |
7 | 20 | <!-- badges: end --> |
8 | 21 |
|
9 | 22 | The goal of ACEsimFit is 1) to simulate kin pairs data based on the |
10 | 23 | theory of ACE models. 2) to fit data with ACE models |
11 | 24 |
|
12 | 25 | ## Installation |
13 | 26 |
|
14 | | -You can install the development version of ACEsimFit like so: |
| 27 | +You can install the official version of ACEsimFit like so: |
15 | 28 |
|
16 | 29 | ``` r |
17 | 30 | install.packages("ACEsimFit") |
18 | 31 | ``` |
19 | 32 |
|
| 33 | +You can also install/update ACEsimFit with the development version of |
| 34 | +ACEsimFit from [GitHub](https://github.com/) with: |
| 35 | + |
| 36 | +``` r |
| 37 | +# If devtools is not installed, uncomment the line below. |
| 38 | +# install.packages('ACEsimFit') |
| 39 | +devtools::install_github('R-Computing-Lab/ACEsimFit') |
| 40 | +``` |
| 41 | + |
| 42 | +## Citation |
| 43 | + |
| 44 | +If you use `ACEsimFit` in your research or wish to refer to it, please |
| 45 | +cite the following paper: |
| 46 | + |
| 47 | +``` r |
| 48 | +citation(package = "ACEsimFit") |
| 49 | +Warning in citation(package = "ACEsimFit"): could not determine year for |
| 50 | +'ACEsimFit' from package DESCRIPTION file |
| 51 | +To cite package 'ACEsimFit' in publications use: |
| 52 | + |
| 53 | + Lyu X, Garrison S (????). _ACEsimFit: ACE Kin Pair Data Simulations |
| 54 | + and Model Fitting_. R package version 0.0.0.9. |
| 55 | + |
| 56 | +A BibTeX entry for LaTeX users is |
| 57 | + |
| 58 | + @Manual{, |
| 59 | + title = {ACEsimFit: ACE Kin Pair Data Simulations and Model Fitting}, |
| 60 | + author = {Xuanyu Lyu and S.Mason Garrison}, |
| 61 | + note = {R package version 0.0.0.9}, |
| 62 | + } |
| 63 | +``` |
| 64 | + |
20 | 65 | ## Example |
21 | 66 |
|
22 | 67 | For user guide and procudure, please check out the examples in the |
|
0 commit comments