Skip to content

Commit c337a29

Browse files
added 2023 paper
1 parent e46c707 commit c337a29

3 files changed

Lines changed: 50 additions & 4 deletions

File tree

DESCRIPTION

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
Package: ACEsimFit
22
Title: ACE Kin Pair Data Simulations and Model Fitting
3-
Version: 0.0.0.9
3+
Version: 0.0.1.0
4+
Date: 2025
45
Authors@R:
56
c(person("Xuanyu", "Lyu", email = "lyux20@wfu.edu", role = c("aut", "cre")),
67
person("S.Mason", "Garrison", email = "garrissm@wfu.edu", role = "aut"))
7-
Description: A few functions aim to provide a statistic tool for three purposes. First, simulate kin pairs data based on the assumption that every trait is affected by genetic effects (A), common environmental effects (C) and unique environmental effects (E). Second, use kin pairs data to fit an ACE model and get model fit output. Third, calculate power of A estimate given a specific condition. For the mechanisms of power calculation, we suggest to check Visscher(2004) <doi:10.1375/twin.7.5.505>.
8+
Description: A few functions aim to provide a statistic tool for three purposes. First, simulate kin pairs data based on the assumption that every trait is affected by genetic effects (A), common environmental effects (C) and unique environmental effects (E). Second, use kin pairs data to fit an ACE model and get model fit output. Third, calculate power of A estimate given a specific condition. For the mechanisms of power calculation, we suggest to read Visscher (2004) <doi:10.1375/twin.7.5.505>, as well as Lyu and Garrison (2023) <doi:10.1017/thg.2023.40>
89
License: MIT + file LICENSE
910
Encoding: UTF-8
1011
Roxygen: list(markdown = TRUE)

README.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ knitr::opts_chunk$set(
1616
# ACEsimFit
1717

1818
<!-- badges: start -->
19-
<a href="https://r-computing-lab.github.io/ACEsimFit/"><img src="man/figures/logo.png" align="right" height="139" alt="discord website" /></a>
19+
2020
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
2121
[![R package version](https://www.r-pkg.org/badges/version/ACEsimFit)](https://cran.r-project.org/package=discord)
2222
[![Package downloads](https://cranlogs.r-pkg.org/badges/grand-total/ACEsimFit)](https://cran.r-project.org/package=ACEsimFit)</br>

README.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,64 @@
44
# ACEsimFit
55

66
<!-- badges: start -->
7+
8+
[![Project Status: Active – The project has reached a stable, usable
9+
state and is being actively
10+
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
11+
[![R package
12+
version](https://www.r-pkg.org/badges/version/ACEsimFit)](https://cran.r-project.org/package=discord)
13+
[![Package
14+
downloads](https://cranlogs.r-pkg.org/badges/grand-total/ACEsimFit)](https://cran.r-project.org/package=ACEsimFit)</br>
15+
[![R-CMD-check](https://github.com/R-Computing-Lab/ACEsimFit/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/R-Computing-Lab/ACEsimFit/actions/workflows/R-CMD-check.yaml)
16+
[![Codecov test
17+
coverage](https://codecov.io/gh/R-Computing-Lab/ACEsimFit/graph/badge.svg)](https://app.codecov.io/gh/R-Computing-Lab/ACEsimFit)
18+
![License](https://img.shields.io/badge/License-GPL_v3-blue.svg)
19+
720
<!-- badges: end -->
821

922
The goal of ACEsimFit is 1) to simulate kin pairs data based on the
1023
theory of ACE models. 2) to fit data with ACE models
1124

1225
## Installation
1326

14-
You can install the development version of ACEsimFit like so:
27+
You can install the official version of ACEsimFit like so:
1528

1629
``` r
1730
install.packages("ACEsimFit")
1831
```
1932

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+
2065
## Example
2166

2267
For user guide and procudure, please check out the examples in the

0 commit comments

Comments
 (0)