-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
66 lines (49 loc) · 2.18 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
---
output:
md_document:
variant: gfm
html_preview: false
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
<!-- First time: run usethis::use_readme_rmd() to create a pre-commit hook that
prevents from committing if the README.Rmd has changed, but has not been
re-knitted to generate an updated README.md -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
```{r echo=FALSE, results="hide", message=FALSE}
require(badger)
```
## echoseq: Faithful replication and simulation of molecular and clinical data <img src="man/figures/echoseq_logo.png" align="right" height="150"/>
<!-- Run for the R CMD checks, run usethis::use_github_actions() to set up the pipeline, possibly modify the .yaml file and then: -->
<!-- `r badge_travis("hruffieux/echoseq")` -->
<!-- `r badge_github_actions("hruffieux/echoseq")` -->
`r badge_license("GPL v3", url = "https://www.gnu.org/licenses/gpl-3.0")`
`r badge_devel("hruffieux/echoseq", "blue")`
`r badge_code_size("hruffieux/echoseq")`
## Overview
**echoseq** is an R package providing functions to emulate molecular quantitative
trait locus data, and clinical data associated with genetic variants under
user-specified association patterns. The data can be obtained by pure simulation
or can replicate real datasets supplied by the user. Datasets simulated using
**echoseq** may replace real datasets when these cannot be shared for diverse
privacy reasons. The data generation schemes are based on generally accepted
principles of population genetics (Hardy–Weinberg equilibrium,
linkage-disequilibrium, natural selection, pleiotropic control, sparsity
assumptions, epigenetic control, etc).
## Installation
To install, run the following commands in R:
``` r
if(!require(remotes)) install.packages("remotes")
remotes::install_github("hruffieux/echoseq")
```
## License and authors
This software uses the GPL v3 license, see [LICENSE](LICENSE).
Authors and copyright are provided in [DESCRIPTION](DESCRIPTION).
## Issues
To report an issue, please use the [echoseq issue tracker](https://github.com/hruffieux/echoseq/issues) at github.com.