forked from DeclareDesign/DesignLibrary
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
44 lines (29 loc) · 2.5 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
---
output:
github_document
title: "DesignLibrary: A Library of Common Research Designs"
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
[](https://travis-ci.org/DeclareDesign/DesignLibrary)
[](https://coveralls.io/github/DeclareDesign/DesignLibrary?branch=master)
[](https://cran.r-project.org/package=DesignLibrary)
[](https://cran.r-project.org/)
[](commits/master)
**DesignLibrary** provides simple interface to build designs using the package **DeclareDesign**. In one line of code users can specify the parameters of individual designs and diagnose their properties. The designers can also be used to compare performance of a given design across a range of combinations of parameters, such as effect size, sample size, assignment probabilities and more.
[Check out the online version of the library here](https://declaredesign.org/library/).
---
## Installing the design library
To install the latest stable release of **DesignLibrary**, please ensure that you are running version 3.4 or later of R and run the following code:
```{r, eval=F}
install.packages("DesignLibrary")
```
If you would like to use the latest development release of **DesignLibrary**, please ensure that you are running version 3.4 or later of R and run the following code:
```{r, eval=F}
devtools::install_github("DeclareDesign/DesignLibrary", keep_source = TRUE)
```
## Contributing designs and designers
We welcome contributions to the library!
- You can [submit static designs](https://declaredesign.org/library/articles/how_to_write_and_contribute_designs.html) made in `DeclareDesign`, which will live as properly attributed entries in the library on our website
- Or you can [submit designer functions that generate designs](https://declaredesign.org/library/articles/how_to_write_and_contribute_designers.html), which may be added to the CRAN version of the package
---
This project is generously supported by a grant from the [Laura and John Arnold Foundation](http://www.arnoldfoundation.org) and seed funding from [Evidence in Governance and Politics (EGAP)](http://egap.org).