prise6/aVirtualTwins
1
0
Fork 0
mirror of https://github.com/prise6/aVirtualTwins.git synced 2024-04-25 19:00:27 +02:00
Code Issues Releases Wiki Activity

fix duplicate Rd help files

Browse source
This commit is contained in:
François Vieille 2016-10-09 02:09:32 +02:00
parent 155d95cc91
commit 842832d1bc
2 changed files with 14 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
man/VT.forest.Rd → man/VT.forest-abstract.Rd
View file

@ -1,4 +1,4 @@
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/forest.R
\docType{class}
\name{VT.forest}
@ -6,8 +6,7 @@
\title{Difft by Random Forest}
\description{
An abstract reference class to compute twin via random forests
}
\details{
\code{VT.forest} extends \code{VT.difft}
}
\section{Fields}{

24
man/VT.tree.Rd → man/VT.tree-abstract.Rd
View file

@ -1,4 +1,4 @@
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/tree.R
\docType{class}
\name{VT.tree}
@ -9,24 +9,24 @@ An abstract reference class to compute tree
}
\details{
\code{VT.tree.class} and \code{VT.tree.reg} are children of \code{VT.tree}.
\code{VT.tree.class} and \code{VT.tree.reg} try to find a strong association
\code{VT.tree.class} and \code{VT.tree.reg} try to find a strong association
between \code{difft} (in \code{VT.difft} object) and RCT variables.
In \code{VT.tree.reg}, a regression tree is computed on \code{difft} values.
Then, thanks to the \code{threshold} it flags leafs of the \code{tree} which
are above the \code{threshold} (when \code{sens} is ">"). Or it flags leafs
In \code{VT.tree.reg}, a regression tree is computed on \code{difft} values.
Then, thanks to the \code{threshold} it flags leafs of the \code{tree} which
are above the \code{threshold} (when \code{sens} is ">"). Or it flags leafs
which are below the \code{threshold} (when \code{sens} = "<").
In \code{VT.tree.class}, it first flags \code{difft} above or below
(depending on the \code{sens}) the given \code{threshold}. Then a
classification tree is computed to find which variables explain flagged
In \code{VT.tree.class}, it first flags \code{difft} above or below
(depending on the \code{sens}) the given \code{threshold}. Then a
classification tree is computed to find which variables explain flagged
\code{difft}.
To sum up, \code{VT.tree} try to understand which variables are associated
To sum up, \code{VT.tree} try to understand which variables are associated
with a big change of \code{difft}.
Results are shown with \code{getRules()} function. \code{only.leaf} parameter
allows to obtain only the leaf of the \code{tree}. \code{only.fav} parameter
allows to obtain only the leaf of the \code{tree}. \code{only.fav} parameter
select only favorable nodes. \code{tables} shows incidence table of the rule.
\code{verbose} allow \code{getRules()} to be quiet. And \code{compete} show
also rules with \code{maxcompete} competitors from the \code{tree}.
@ -40,10 +40,10 @@ also rules with \code{maxcompete} competitors from the \code{tree}.
\item{\code{threshold}}{numeric Threshold for difft calculation (c)}
\item{\code{screening}}{Logical. TRUE if using varimp. Default is VT.object
\item{\code{screening}}{Logical. TRUE if using varimp. Default is VT.object
screening field}
\item{\code{sens}}{character Sens can be ">" (default) or "<". Meaning :
\item{\code{sens}}{character Sens can be ">" (default) or "<". Meaning :
\code{difft} > \code{threshold} or \code{difft} < \code{threshold}}
\item{\code{name}}{character Names of the tree}