Fill for the first time README
This commit is contained in:
parent
040bb85116
commit
dee06cfe9a
50
README.md
50
README.md
|
@ -1 +1,49 @@
|
|||
# VirtualTwins
|
||||
# VirtualTwins
|
||||
|
||||
An adaptation of VirtualTwins method from [Foster, J. C., Taylor, J. M.G. and Ruberg, S. J. (2011)](http://onlinelibrary.wiley.com/doi/10.1002/sim.4322/abstract)
|
||||
|
||||
VirtualTwins is a method of subgroup identification from randomized clinical trial data.
|
||||
|
||||
As an intern in a french pharmaceutical group, i worked on this method and develop a package based on Jared Foster and al method.
|
||||
|
||||
## Infos
|
||||
|
||||
Currently this package works for RCT with two treatments groups and binary outcome.
|
||||
|
||||
This is the *dev version 0.0.0.2* and often updated.
|
||||
|
||||
Most of the package use Reference Class programing (in R)
|
||||
|
||||
I got a *WARNING* when Checking package for "cheking PDF version of manual" because of my version of LaTeX. Need to fix it.
|
||||
|
||||
## To-do list
|
||||
|
||||
* Description and help
|
||||
* Vignette example
|
||||
* ...
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
# use devtools library
|
||||
library(devtools)
|
||||
# install from github
|
||||
devtools::install_github("prise6/VirtualTwins@dev")
|
||||
# load library
|
||||
library(VirtualTwins)
|
||||
```
|
||||
|
||||
## Help
|
||||
|
||||
*Vignette really not finished ... *
|
||||
|
||||
See /doc/full-example.Rmd
|
||||
or :
|
||||
```
|
||||
vignette("full-example", package = "VirtualTwins")
|
||||
```
|
||||
|
||||
## Few Examples
|
||||
|
||||
* Coming...*
|
||||
|
||||
|
|
Loading…
Reference in New Issue