From 842832d1bcd045e839febca6a791836513dd41cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Vieille?= Date: Sun, 9 Oct 2016 02:09:32 +0200 Subject: [PATCH] fix duplicate Rd help files --- man/{VT.forest.Rd => VT.forest-abstract.Rd} | 5 ++--- man/{VT.tree.Rd => VT.tree-abstract.Rd} | 24 ++++++++++----------- 2 files changed, 14 insertions(+), 15 deletions(-) rename man/{VT.forest.Rd => VT.forest-abstract.Rd} (91%) rename man/{VT.tree.Rd => VT.tree-abstract.Rd} (94%) diff --git a/man/VT.forest.Rd b/man/VT.forest-abstract.Rd similarity index 91% rename from man/VT.forest.Rd rename to man/VT.forest-abstract.Rd index af2a515..0dcffce 100644 --- a/man/VT.forest.Rd +++ b/man/VT.forest-abstract.Rd @@ -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}{ diff --git a/man/VT.tree.Rd b/man/VT.tree-abstract.Rd similarity index 94% rename from man/VT.tree.Rd rename to man/VT.tree-abstract.Rd index 2aea263..ac7121b 100644 --- a/man/VT.tree.Rd +++ b/man/VT.tree-abstract.Rd @@ -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}