1
0
Fork 0
mirror of https://github.com/prise6/aVirtualTwins.git synced 2024-05-04 20:13:11 +02:00
aVirtualTwins/R/aVirtualTwins.R
2015-07-27 01:40:52 +02:00

27 lines
1.1 KiB
R

#' aVirtualTwins : An adapation of VirtualTwins method created by Jared Foster.
#'
#' aVirtualTwins is written mainly with reference classes. Briefly, there is three kinds of class :
#' \itemize{
#' \item \code{\link{VT.object}} class to represent RCT dataset used by aVirtualTwins. To format correctly RCT dataset, use \code{\link{formatRCTDataset}}.
#' \item \code{\link{VT.difft}} class to compute difference between twins. Family \code{\link{VT.forest}} extends it to compute twins by random forest.
#' \code{\link{vt.forest()}} is users function.
#' \item \code{\link{VT.tree}} class to find subgroups from \code{difft} by CART trees. \code{\link{VT.tree.class}} and \code{\link{VT.tree.reg}} extend it.
#' \code{\link{vt.tree()}} is users function.
#' }
#'
#' @section TODO LIST:
#' \emph{last update : 27.07.2015}
#' \itemize{
#' \item More detailed documentation and vignettes
#' \item Write examples
#' \item ...
#' }
#'
#' See github.com/prise6/aVirtualTwins for last updates.
#'
#' @docType package
#' @name aVirtualTwins
#' @aliases aVirtualTwins-package
#'
NULL