mirror of
https://github.com/prise6/aVirtualTwins.git
synced 2024-05-06 20:26:34 +02:00
fix duplicate Rd help files
This commit is contained in:
parent
155d95cc91
commit
842832d1bc
|
@ -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
|
% Please edit documentation in R/forest.R
|
||||||
\docType{class}
|
\docType{class}
|
||||||
\name{VT.forest}
|
\name{VT.forest}
|
||||||
|
@ -6,8 +6,7 @@
|
||||||
\title{Difft by Random Forest}
|
\title{Difft by Random Forest}
|
||||||
\description{
|
\description{
|
||||||
An abstract reference class to compute twin via random forests
|
An abstract reference class to compute twin via random forests
|
||||||
}
|
|
||||||
\details{
|
|
||||||
\code{VT.forest} extends \code{VT.difft}
|
\code{VT.forest} extends \code{VT.difft}
|
||||||
}
|
}
|
||||||
\section{Fields}{
|
\section{Fields}{
|
|
@ -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
|
% Please edit documentation in R/tree.R
|
||||||
\docType{class}
|
\docType{class}
|
||||||
\name{VT.tree}
|
\name{VT.tree}
|
||||||
|
@ -9,24 +9,24 @@ An abstract reference class to compute tree
|
||||||
}
|
}
|
||||||
\details{
|
\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} 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.
|
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.
|
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
|
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
|
are above the \code{threshold} (when \code{sens} is ">"). Or it flags leafs
|
||||||
which are below the \code{threshold} (when \code{sens} = "<").
|
which are below the \code{threshold} (when \code{sens} = "<").
|
||||||
|
|
||||||
In \code{VT.tree.class}, it first flags \code{difft} above or below
|
In \code{VT.tree.class}, it first flags \code{difft} above or below
|
||||||
(depending on the \code{sens}) the given \code{threshold}. Then a
|
(depending on the \code{sens}) the given \code{threshold}. Then a
|
||||||
classification tree is computed to find which variables explain flagged
|
classification tree is computed to find which variables explain flagged
|
||||||
\code{difft}.
|
\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}.
|
with a big change of \code{difft}.
|
||||||
|
|
||||||
Results are shown with \code{getRules()} function. \code{only.leaf} parameter
|
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.
|
select only favorable nodes. \code{tables} shows incidence table of the rule.
|
||||||
\code{verbose} allow \code{getRules()} to be quiet. And \code{compete} show
|
\code{verbose} allow \code{getRules()} to be quiet. And \code{compete} show
|
||||||
also rules with \code{maxcompete} competitors from the \code{tree}.
|
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{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}
|
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}}
|
\code{difft} > \code{threshold} or \code{difft} < \code{threshold}}
|
||||||
|
|
||||||
\item{\code{name}}{character Names of the tree}
|
\item{\code{name}}{character Names of the tree}
|
Loading…
Reference in a new issue