R/TMS_RFC1.R

In fernandoPalluzzi/tmsClassifier: Random Forest Classifiers for Transcranial Magnetic Stimulation Data

#  tmsClassifier library
#  Copyright (C) 2019 Fernando Palluzzi; Mario Grassi
#  e-mail: <fernando.palluzzi@gmail.com>
#  University of Pavia, Department of Brain and Behavioral Sciences
#  Via Bassi 21, Pavia, 27100 Italy

#  tmsClassifier is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.

#  tmsClassifier is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.

#  You should have received a copy of the GNU General Public License
#  along with this program.  If not, see <http://www.gnu.org/licenses/>.

# -------------------------------------------------------------------- #


#' @title D-HC Random Forest Classifier (RFC1)
#'
#' @description This is the first of three RFCs used by tmsClssifier to
#' predict subjects' disgnosis on the base of TMS data. RFC1 classifies 
#' subjects in either "Diseased" (AD, FTD, or DLB) or "Healthy" (i.e. the
#' typical TMS signature of heathy controls). If a subject is classified
#' as "Diseased", the classification process moves to the second classifier
#' (RFC2). In case of an "Healthy" subject, the classification process
#' terminates.
#' @name tms.rfc1
#' @usage tms.rfc1
#' @docType data
#' @format
#' "tms.rfc1" is an object of class \code{\link[randomForest]{randomForest}}.
#'
NULL